@azure/arm-digitaltwins 2.1.1 → 3.0.0

package/types/arm-digitaltwins.d.ts

@@ -0,0 +1,1009 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+/**
+ * Defines values for AuthenticationType. \
+ * {@link KnownAuthenticationType} can be used interchangeably with AuthenticationType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **KeyBased** \
+ * **IdentityBased**
+ */
+export declare type AuthenticationType = string;
+
+export declare class AzureDigitalTwinsManagementClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the AzureDigitalTwinsManagementClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId The subscription identifier.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureDigitalTwinsManagementClientOptionalParams);
+    digitalTwins: DigitalTwins;
+    digitalTwinsEndpoint: DigitalTwinsEndpoint;
+    operations: Operations;
+    privateLinkResources: PrivateLinkResources;
+    privateEndpointConnections: PrivateEndpointConnections;
+}
+
+/** Optional parameters. */
+export declare interface AzureDigitalTwinsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** The result returned from a database check name availability request. */
+export declare interface CheckNameRequest {
+    /** Resource name. */
+    name: string;
+    /** The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances. */
+    type: "Microsoft.DigitalTwins/digitalTwinsInstances";
+}
+
+/** The result returned from a check name availability request. */
+export declare interface CheckNameResult {
+    /** Specifies a Boolean value that indicates if the name is available. */
+    nameAvailable?: boolean;
+    /** Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. */
+    message?: string;
+    /** Message providing the reason why the given name is invalid. */
+    reason?: Reason;
+}
+
+/** The properties of a private endpoint connection. */
+export declare interface ConnectionProperties {
+    /**
+     * The provisioning state.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ConnectionPropertiesProvisioningState;
+    privateEndpoint?: ConnectionPropertiesPrivateEndpoint;
+    /** The list of group ids for the private endpoint connection. */
+    groupIds?: string[];
+    privateLinkServiceConnectionState?: ConnectionPropertiesPrivateLinkServiceConnectionState;
+}
+
+export declare type ConnectionPropertiesPrivateEndpoint = PrivateEndpoint & {};
+
+export declare type ConnectionPropertiesPrivateLinkServiceConnectionState = ConnectionState & {};
+
+/**
+ * Defines values for ConnectionPropertiesProvisioningState. \
+ * {@link KnownConnectionPropertiesProvisioningState} can be used interchangeably with ConnectionPropertiesProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Pending** \
+ * **Approved** \
+ * **Rejected** \
+ * **Disconnected**
+ */
+export declare type ConnectionPropertiesProvisioningState = string;
+
+/** The current state of a private endpoint connection. */
+export declare interface ConnectionState {
+    /** The status of a private endpoint connection. */
+    status: PrivateLinkServiceConnectionStatus;
+    /** The description for the current state of a private endpoint connection. */
+    description: string;
+    /** Actions required for a private endpoint connection. */
+    actionsRequired?: string;
+}
+
+/** Interface representing a DigitalTwins. */
+export declare interface DigitalTwins {
+    /**
+     * Get all the DigitalTwinsInstances in a subscription.
+     * @param options The options parameters.
+     */
+    list(options?: DigitalTwinsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription>;
+    /**
+     * Get all the DigitalTwinsInstances in a resource group.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: DigitalTwinsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription>;
+    /**
+     * Get DigitalTwinsInstances resource.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceName: string, options?: DigitalTwinsGetOptionalParams): Promise<DigitalTwinsGetResponse>;
+    /**
+     * Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is
+     * to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified
+     * values in a new body to update the DigitalTwinsInstance.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param digitalTwinsCreate The DigitalTwinsInstance and security metadata.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsCreateOrUpdateResponse>, DigitalTwinsCreateOrUpdateResponse>>;
+    /**
+     * Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is
+     * to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified
+     * values in a new body to update the DigitalTwinsInstance.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param digitalTwinsCreate The DigitalTwinsInstance and security metadata.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<DigitalTwinsCreateOrUpdateResponse>;
+    /**
+     * Update metadata of DigitalTwinsInstance.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param digitalTwinsPatchDescription The DigitalTwinsInstance and security metadata.
+     * @param options The options parameters.
+     */
+    beginUpdate(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsUpdateResponse>, DigitalTwinsUpdateResponse>>;
+    /**
+     * Update metadata of DigitalTwinsInstance.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param digitalTwinsPatchDescription The DigitalTwinsInstance and security metadata.
+     * @param options The options parameters.
+     */
+    beginUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>;
+    /**
+     * Delete a DigitalTwinsInstance.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsDeleteResponse>, DigitalTwinsDeleteResponse>>;
+    /**
+     * Delete a DigitalTwinsInstance.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<DigitalTwinsDeleteResponse>;
+    /**
+     * Check if a DigitalTwinsInstance name is available.
+     * @param location Location of DigitalTwinsInstance.
+     * @param digitalTwinsInstanceCheckName Set the name parameter in the DigitalTwinsInstanceCheckName
+     *                                      structure to the name of the DigitalTwinsInstance to check.
+     * @param options The options parameters.
+     */
+    checkNameAvailability(location: string, digitalTwinsInstanceCheckName: CheckNameRequest, options?: DigitalTwinsCheckNameAvailabilityOptionalParams): Promise<DigitalTwinsCheckNameAvailabilityResponse>;
+}
+
+/** Optional parameters. */
+export declare interface DigitalTwinsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the checkNameAvailability operation. */
+export declare type DigitalTwinsCheckNameAvailabilityResponse = CheckNameResult;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type DigitalTwinsCreateOrUpdateResponse = DigitalTwinsDescription;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the delete operation. */
+export declare type DigitalTwinsDeleteResponse = DigitalTwinsDescription;
+
+/** The description of the DigitalTwins service. */
+export declare type DigitalTwinsDescription = DigitalTwinsResource & {
+    /**
+     * Time when DigitalTwinsInstance was created.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly createdTime?: Date;
+    /**
+     * Time when DigitalTwinsInstance was updated.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly lastUpdatedTime?: Date;
+    /**
+     * The provisioning state.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+    /**
+     * Api endpoint to work with DigitalTwinsInstance.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly hostName?: string;
+    privateEndpointConnections?: PrivateEndpointConnection[];
+    /** Public network access for the DigitalTwinsInstance. */
+    publicNetworkAccess?: PublicNetworkAccess;
+};
+
+/** A list of DigitalTwins description objects with a next link. */
+export declare interface DigitalTwinsDescriptionListResult {
+    /** The link used to get the next page of DigitalTwins description objects. */
+    nextLink?: string;
+    /** A list of DigitalTwins description objects. */
+    value?: DigitalTwinsDescription[];
+}
+
+/** Interface representing a DigitalTwinsEndpoint. */
+export declare interface DigitalTwinsEndpoint {
+    /**
+     * Get DigitalTwinsInstance Endpoints.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, resourceName: string, options?: DigitalTwinsEndpointListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsEndpointResource>;
+    /**
+     * Get DigitalTwinsInstances Endpoint.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param endpointName Name of Endpoint Resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointGetOptionalParams): Promise<DigitalTwinsEndpointGetResponse>;
+    /**
+     * Create or update DigitalTwinsInstance endpoint.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param endpointName Name of Endpoint Resource.
+     * @param endpointDescription The DigitalTwinsInstance endpoint metadata and security metadata.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, endpointName: string, endpointDescription: DigitalTwinsEndpointResource, options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsEndpointCreateOrUpdateResponse>, DigitalTwinsEndpointCreateOrUpdateResponse>>;
+    /**
+     * Create or update DigitalTwinsInstance endpoint.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param endpointName Name of Endpoint Resource.
+     * @param endpointDescription The DigitalTwinsInstance endpoint metadata and security metadata.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, endpointName: string, endpointDescription: DigitalTwinsEndpointResource, options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams): Promise<DigitalTwinsEndpointCreateOrUpdateResponse>;
+    /**
+     * Delete a DigitalTwinsInstance endpoint.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param endpointName Name of Endpoint Resource.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointDeleteOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsEndpointDeleteResponse>, DigitalTwinsEndpointDeleteResponse>>;
+    /**
+     * Delete a DigitalTwinsInstance endpoint.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param endpointName Name of Endpoint Resource.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointDeleteOptionalParams): Promise<DigitalTwinsEndpointDeleteResponse>;
+}
+
+/** Optional parameters. */
+export declare interface DigitalTwinsEndpointCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type DigitalTwinsEndpointCreateOrUpdateResponse = DigitalTwinsEndpointResource;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsEndpointDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the delete operation. */
+export declare type DigitalTwinsEndpointDeleteResponse = DigitalTwinsEndpointResource;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsEndpointGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type DigitalTwinsEndpointGetResponse = DigitalTwinsEndpointResource;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsEndpointListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type DigitalTwinsEndpointListNextResponse = DigitalTwinsEndpointResourceListResult;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsEndpointListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type DigitalTwinsEndpointListResponse = DigitalTwinsEndpointResourceListResult;
+
+/** DigitalTwinsInstance endpoint resource. */
+export declare type DigitalTwinsEndpointResource = ExternalResource & {
+    /** DigitalTwinsInstance endpoint resource properties. */
+    properties: DigitalTwinsEndpointResourcePropertiesUnion;
+};
+
+/** A list of DigitalTwinsInstance Endpoints with a next link. */
+export declare interface DigitalTwinsEndpointResourceListResult {
+    /** The link used to get the next page of DigitalTwinsInstance Endpoints. */
+    nextLink?: string;
+    /** A list of DigitalTwinsInstance Endpoints. */
+    value?: DigitalTwinsEndpointResource[];
+}
+
+/** Properties related to Digital Twins Endpoint */
+export declare interface DigitalTwinsEndpointResourceProperties {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    endpointType: "ServiceBus" | "EventHub" | "EventGrid";
+    /**
+     * The provisioning state.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: EndpointProvisioningState;
+    /**
+     * Time when the Endpoint was added to DigitalTwinsInstance.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly createdTime?: Date;
+    /** Specifies the authentication type being used for connecting to the endpoint. */
+    authenticationType?: AuthenticationType;
+    /** Dead letter storage secret for key-based authentication. Will be obfuscated during read. */
+    deadLetterSecret?: string;
+    /** Dead letter storage URL for identity-based authentication. */
+    deadLetterUri?: string;
+}
+
+export declare type DigitalTwinsEndpointResourcePropertiesUnion = DigitalTwinsEndpointResourceProperties | ServiceBus | EventHub | EventGrid;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type DigitalTwinsGetResponse = DigitalTwinsDescription;
+
+/** The managed identity for the DigitalTwinsInstance. */
+export declare interface DigitalTwinsIdentity {
+    /** The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. */
+    type?: DigitalTwinsIdentityType;
+    /**
+     * The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly tenantId?: string;
+}
+
+/**
+ * Defines values for DigitalTwinsIdentityType. \
+ * {@link KnownDigitalTwinsIdentityType} can be used interchangeably with DigitalTwinsIdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **None** \
+ * **SystemAssigned**
+ */
+export declare type DigitalTwinsIdentityType = string;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type DigitalTwinsListByResourceGroupNextResponse = DigitalTwinsDescriptionListResult;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type DigitalTwinsListByResourceGroupResponse = DigitalTwinsDescriptionListResult;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type DigitalTwinsListNextResponse = DigitalTwinsDescriptionListResult;
+
+/** Optional parameters. */
+export declare interface DigitalTwinsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type DigitalTwinsListResponse = DigitalTwinsDescriptionListResult;
+
+/** The description of the DigitalTwins service. */
+export declare interface DigitalTwinsPatchDescription {
+    /** Instance patch properties */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The managed identity for the DigitalTwinsInstance. */
+    identity?: DigitalTwinsIdentity;
+    /** Properties for the DigitalTwinsInstance. */
+    properties?: DigitalTwinsPatchProperties;
+}
+
+/** The properties of a DigitalTwinsInstance. */
+export declare interface DigitalTwinsPatchProperties {
+    /** Public network access for the DigitalTwinsInstance. */
+    publicNetworkAccess?: PublicNetworkAccess;
+}
+
+/** The common properties of a DigitalTwinsInstance. */
+export declare interface DigitalTwinsResource {
+    /**
+     * The resource identifier.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The resource name.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /** The resource location. */
+    location: string;
+    /** The resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The managed identity for the DigitalTwinsInstance. */
+    identity?: DigitalTwinsIdentity;
+}
+
+/** Optional parameters. */
+export declare interface DigitalTwinsUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the update operation. */
+export declare type DigitalTwinsUpdateResponse = DigitalTwinsDescription;
+
+/**
+ * Defines values for EndpointProvisioningState. \
+ * {@link KnownEndpointProvisioningState} can be used interchangeably with EndpointProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Provisioning** \
+ * **Deleting** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Deleted** \
+ * **Warning** \
+ * **Suspending** \
+ * **Restoring** \
+ * **Moving** \
+ * **Disabled**
+ */
+export declare type EndpointProvisioningState = string;
+
+/**
+ * Defines values for EndpointType. \
+ * {@link KnownEndpointType} can be used interchangeably with EndpointType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **EventHub** \
+ * **EventGrid** \
+ * **ServiceBus**
+ */
+export declare type EndpointType = string;
+
+/** Error definition. */
+export declare interface ErrorDefinition {
+    /**
+     * Service specific error code which serves as the substatus for the HTTP error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * Description of the error.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * Internal error details.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorDefinition[];
+}
+
+/** Error response. */
+export declare interface ErrorResponse {
+    /** Error description */
+    error?: ErrorDefinition;
+}
+
+/** Properties related to EventGrid. */
+export declare type EventGrid = DigitalTwinsEndpointResourceProperties & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    endpointType: "EventGrid";
+    /** EventGrid Topic Endpoint */
+    topicEndpoint: string;
+    /** EventGrid secondary accesskey. Will be obfuscated during read. */
+    accessKey1: string | null;
+    /** EventGrid secondary accesskey. Will be obfuscated during read. */
+    accessKey2?: string;
+};
+
+/** Properties related to EventHub. */
+export declare type EventHub = DigitalTwinsEndpointResourceProperties & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    endpointType: "EventHub";
+    /** PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
+    connectionStringPrimaryKey?: string;
+    /** SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
+    connectionStringSecondaryKey?: string;
+    /** The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb:// */
+    endpointUri?: string;
+    /** The EventHub name in the EventHub namespace for identity-based authentication. */
+    entityPath?: string;
+};
+
+/** Definition of a resource. */
+export declare interface ExternalResource {
+    /**
+     * The resource identifier.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * Extension resource name.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+}
+
+/** The group information for creating a private endpoint on Digital Twin. */
+export declare interface GroupIdInformation {
+    properties: GroupIdInformationProperties;
+    /** The resource identifier. */
+    id?: string;
+    /**
+     * The resource name.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+}
+
+export declare type GroupIdInformationProperties = GroupIdInformationPropertiesAutoGenerated & {};
+
+/** The properties for a group information object. */
+export declare interface GroupIdInformationPropertiesAutoGenerated {
+    /** The group id */
+    groupId?: string;
+    /** The required members for a specific group id. */
+    requiredMembers?: string[];
+    /** The required DNS zones for a specific group id. */
+    requiredZoneNames?: string[];
+}
+
+/** The available private link resources for a Digital Twin. */
+export declare interface GroupIdInformationResponse {
+    /** The list of available private link resources for a Digital Twin. */
+    value?: GroupIdInformation[];
+}
+
+/** Known values of {@link AuthenticationType} that the service accepts. */
+export declare enum KnownAuthenticationType {
+    KeyBased = "KeyBased",
+    IdentityBased = "IdentityBased"
+}
+
+/** Known values of {@link ConnectionPropertiesProvisioningState} that the service accepts. */
+export declare enum KnownConnectionPropertiesProvisioningState {
+    Pending = "Pending",
+    Approved = "Approved",
+    Rejected = "Rejected",
+    Disconnected = "Disconnected"
+}
+
+/** Known values of {@link DigitalTwinsIdentityType} that the service accepts. */
+export declare enum KnownDigitalTwinsIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned"
+}
+
+/** Known values of {@link EndpointProvisioningState} that the service accepts. */
+export declare enum KnownEndpointProvisioningState {
+    Provisioning = "Provisioning",
+    Deleting = "Deleting",
+    Succeeded = "Succeeded",
+    Failed = "Failed",
+    Canceled = "Canceled",
+    Deleted = "Deleted",
+    Warning = "Warning",
+    Suspending = "Suspending",
+    Restoring = "Restoring",
+    Moving = "Moving",
+    Disabled = "Disabled"
+}
+
+/** Known values of {@link EndpointType} that the service accepts. */
+export declare enum KnownEndpointType {
+    EventHub = "EventHub",
+    EventGrid = "EventGrid",
+    ServiceBus = "ServiceBus"
+}
+
+/** Known values of {@link PrivateLinkServiceConnectionStatus} that the service accepts. */
+export declare enum KnownPrivateLinkServiceConnectionStatus {
+    Pending = "Pending",
+    Approved = "Approved",
+    Rejected = "Rejected",
+    Disconnected = "Disconnected"
+}
+
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export declare enum KnownProvisioningState {
+    Provisioning = "Provisioning",
+    Deleting = "Deleting",
+    Updating = "Updating",
+    Succeeded = "Succeeded",
+    Failed = "Failed",
+    Canceled = "Canceled",
+    Deleted = "Deleted",
+    Warning = "Warning",
+    Suspending = "Suspending",
+    Restoring = "Restoring",
+    Moving = "Moving"
+}
+
+/** Known values of {@link PublicNetworkAccess} that the service accepts. */
+export declare enum KnownPublicNetworkAccess {
+    Enabled = "Enabled",
+    Disabled = "Disabled"
+}
+
+/** Known values of {@link Reason} that the service accepts. */
+export declare enum KnownReason {
+    Invalid = "Invalid",
+    AlreadyExists = "AlreadyExists"
+}
+
+/** DigitalTwins service REST API operation */
+export declare interface Operation {
+    /**
+     * Operation name: {provider}/{resource}/{read | write | action | delete}
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /** Operation properties display */
+    display?: OperationDisplay;
+    /**
+     * The intended executor of the operation.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly origin?: string;
+    /**
+     * If the operation is a data action (for data plane rbac).
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly isDataAction?: boolean;
+}
+
+/** The object that represents the operation. */
+export declare interface OperationDisplay {
+    /**
+     * Service provider: Microsoft DigitalTwins
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provider?: string;
+    /**
+     * Resource Type: DigitalTwinsInstances
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resource?: string;
+    /**
+     * Name of the operation
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly operation?: string;
+    /**
+     * Friendly description for the operation,
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly description?: string;
+}
+
+/** A list of DigitalTwins service operations. It contains a list of operations and a URL link to get the next set of results. */
+export declare interface OperationListResult {
+    /** The link used to get the next page of DigitalTwins description objects. */
+    nextLink?: string;
+    /**
+     * A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: Operation[];
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Lists all of the available DigitalTwins service REST API operations.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type OperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = OperationListResult;
+
+/** The private endpoint property of a private endpoint connection. */
+export declare interface PrivateEndpoint {
+    /**
+     * The resource identifier.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+}
+
+/** The private endpoint connection of a Digital Twin. */
+export declare interface PrivateEndpointConnection {
+    /**
+     * The resource identifier.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The resource name.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    properties: PrivateEndpointConnectionProperties;
+}
+
+export declare type PrivateEndpointConnectionProperties = ConnectionProperties & {};
+
+/** Interface representing a PrivateEndpointConnections. */
+export declare interface PrivateEndpointConnections {
+    /**
+     * List private endpoint connection properties.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, resourceName: string, options?: PrivateEndpointConnectionsListOptionalParams): Promise<PrivateEndpointConnectionsListResponse>;
+    /**
+     * Get private endpoint connection properties for the given private endpoint.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param privateEndpointConnectionName The name of the private endpoint connection.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
+    /**
+     * Delete private endpoint connection with the specified name.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param privateEndpointConnectionName The name of the private endpoint connection.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Delete private endpoint connection with the specified name.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param privateEndpointConnectionName The name of the private endpoint connection.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>;
+    /**
+     * Update the status of a private endpoint connection with the given name.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param privateEndpointConnectionName The name of the private endpoint connection.
+     * @param privateEndpointConnection The private endpoint connection with updated properties.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
+    /**
+     * Update the status of a private endpoint connection with the given name.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param privateEndpointConnectionName The name of the private endpoint connection.
+     * @param privateEndpointConnection The private endpoint connection with updated properties.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnectionsCreateOrUpdateResponse>;
+}
+
+/** Optional parameters. */
+export declare interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
+
+/** Optional parameters. */
+export declare interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Optional parameters. */
+export declare interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
+
+/** Optional parameters. */
+export declare interface PrivateEndpointConnectionsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type PrivateEndpointConnectionsListResponse = PrivateEndpointConnectionsResponse;
+
+/** The available private link connections for a Digital Twin. */
+export declare interface PrivateEndpointConnectionsResponse {
+    /** The list of available private link connections for a Digital Twin. */
+    value?: PrivateEndpointConnection[];
+}
+
+/** Interface representing a PrivateLinkResources. */
+export declare interface PrivateLinkResources {
+    /**
+     * List private link resources for given Digital Twin.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, resourceName: string, options?: PrivateLinkResourcesListOptionalParams): Promise<PrivateLinkResourcesListResponse>;
+    /**
+     * Get the specified private link resource for the given Digital Twin.
+     * @param resourceGroupName The name of the resource group that contains the DigitalTwinsInstance.
+     * @param resourceName The name of the DigitalTwinsInstance.
+     * @param resourceId The name of the private link resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceName: string, resourceId: string, options?: PrivateLinkResourcesGetOptionalParams): Promise<PrivateLinkResourcesGetResponse>;
+}
+
+/** Optional parameters. */
+export declare interface PrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type PrivateLinkResourcesGetResponse = GroupIdInformation;
+
+/** Optional parameters. */
+export declare interface PrivateLinkResourcesListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type PrivateLinkResourcesListResponse = GroupIdInformationResponse;
+
+/**
+ * Defines values for PrivateLinkServiceConnectionStatus. \
+ * {@link KnownPrivateLinkServiceConnectionStatus} can be used interchangeably with PrivateLinkServiceConnectionStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Pending** \
+ * **Approved** \
+ * **Rejected** \
+ * **Disconnected**
+ */
+export declare type PrivateLinkServiceConnectionStatus = string;
+
+/**
+ * Defines values for ProvisioningState. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Provisioning** \
+ * **Deleting** \
+ * **Updating** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Deleted** \
+ * **Warning** \
+ * **Suspending** \
+ * **Restoring** \
+ * **Moving**
+ */
+export declare type ProvisioningState = string;
+
+/**
+ * Defines values for PublicNetworkAccess. \
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Enabled** \
+ * **Disabled**
+ */
+export declare type PublicNetworkAccess = string;
+
+/**
+ * Defines values for Reason. \
+ * {@link KnownReason} can be used interchangeably with Reason,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Invalid** \
+ * **AlreadyExists**
+ */
+export declare type Reason = string;
+
+/** Properties related to ServiceBus. */
+export declare type ServiceBus = DigitalTwinsEndpointResourceProperties & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    endpointType: "ServiceBus";
+    /** PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
+    primaryConnectionString?: string;
+    /** SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */
+    secondaryConnectionString?: string;
+    /** The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb:// */
+    endpointUri?: string;
+    /** The ServiceBus Topic name for identity-based authentication */
+    entityPath?: string;
+};
+
+export { }