@azure/arm-digitaltwins 2.1.1 → 3.0.0

package/review/arm-digitaltwins.api.md

@@ -0,0 +1,620 @@
+## API Report File for "@azure/arm-digitaltwins"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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';
+
+// @public
+export type AuthenticationType = string;
+
+// @public (undocumented)
+export class AzureDigitalTwinsManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureDigitalTwinsManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    digitalTwins: DigitalTwins;
+    // (undocumented)
+    digitalTwinsEndpoint: DigitalTwinsEndpoint;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    privateEndpointConnections: PrivateEndpointConnections;
+    // (undocumented)
+    privateLinkResources: PrivateLinkResources;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface AzureDigitalTwinsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface CheckNameRequest {
+    name: string;
+    type: "Microsoft.DigitalTwins/digitalTwinsInstances";
+}
+
+// @public
+export interface CheckNameResult {
+    message?: string;
+    nameAvailable?: boolean;
+    reason?: Reason;
+}
+
+// @public
+export interface ConnectionProperties {
+    groupIds?: string[];
+    // (undocumented)
+    privateEndpoint?: ConnectionPropertiesPrivateEndpoint;
+    // (undocumented)
+    privateLinkServiceConnectionState?: ConnectionPropertiesPrivateLinkServiceConnectionState;
+    readonly provisioningState?: ConnectionPropertiesProvisioningState;
+}
+
+// @public (undocumented)
+export type ConnectionPropertiesPrivateEndpoint = PrivateEndpoint & {};
+
+// @public (undocumented)
+export type ConnectionPropertiesPrivateLinkServiceConnectionState = ConnectionState & {};
+
+// @public
+export type ConnectionPropertiesProvisioningState = string;
+
+// @public
+export interface ConnectionState {
+    actionsRequired?: string;
+    description: string;
+    status: PrivateLinkServiceConnectionStatus;
+}
+
+// @public
+export interface DigitalTwins {
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsCreateOrUpdateResponse>, DigitalTwinsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<DigitalTwinsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsDeleteResponse>, DigitalTwinsDeleteResponse>>;
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<DigitalTwinsDeleteResponse>;
+    beginUpdate(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsUpdateResponse>, DigitalTwinsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>;
+    checkNameAvailability(location: string, digitalTwinsInstanceCheckName: CheckNameRequest, options?: DigitalTwinsCheckNameAvailabilityOptionalParams): Promise<DigitalTwinsCheckNameAvailabilityResponse>;
+    get(resourceGroupName: string, resourceName: string, options?: DigitalTwinsGetOptionalParams): Promise<DigitalTwinsGetResponse>;
+    list(options?: DigitalTwinsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription>;
+    listByResourceGroup(resourceGroupName: string, options?: DigitalTwinsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription>;
+}
+
+// @public
+export interface DigitalTwinsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsCheckNameAvailabilityResponse = CheckNameResult;
+
+// @public
+export interface DigitalTwinsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DigitalTwinsCreateOrUpdateResponse = DigitalTwinsDescription;
+
+// @public
+export interface DigitalTwinsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DigitalTwinsDeleteResponse = DigitalTwinsDescription;
+
+// @public
+export type DigitalTwinsDescription = DigitalTwinsResource & {
+    readonly createdTime?: Date;
+    readonly lastUpdatedTime?: Date;
+    readonly provisioningState?: ProvisioningState;
+    readonly hostName?: string;
+    privateEndpointConnections?: PrivateEndpointConnection[];
+    publicNetworkAccess?: PublicNetworkAccess;
+};
+
+// @public
+export interface DigitalTwinsDescriptionListResult {
+    nextLink?: string;
+    value?: DigitalTwinsDescription[];
+}
+
+// @public
+export interface DigitalTwinsEndpoint {
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, endpointName: string, endpointDescription: DigitalTwinsEndpointResource, options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsEndpointCreateOrUpdateResponse>, DigitalTwinsEndpointCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, endpointName: string, endpointDescription: DigitalTwinsEndpointResource, options?: DigitalTwinsEndpointCreateOrUpdateOptionalParams): Promise<DigitalTwinsEndpointCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointDeleteOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsEndpointDeleteResponse>, DigitalTwinsEndpointDeleteResponse>>;
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointDeleteOptionalParams): Promise<DigitalTwinsEndpointDeleteResponse>;
+    get(resourceGroupName: string, resourceName: string, endpointName: string, options?: DigitalTwinsEndpointGetOptionalParams): Promise<DigitalTwinsEndpointGetResponse>;
+    list(resourceGroupName: string, resourceName: string, options?: DigitalTwinsEndpointListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsEndpointResource>;
+}
+
+// @public
+export interface DigitalTwinsEndpointCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DigitalTwinsEndpointCreateOrUpdateResponse = DigitalTwinsEndpointResource;
+
+// @public
+export interface DigitalTwinsEndpointDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DigitalTwinsEndpointDeleteResponse = DigitalTwinsEndpointResource;
+
+// @public
+export interface DigitalTwinsEndpointGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsEndpointGetResponse = DigitalTwinsEndpointResource;
+
+// @public
+export interface DigitalTwinsEndpointListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsEndpointListNextResponse = DigitalTwinsEndpointResourceListResult;
+
+// @public
+export interface DigitalTwinsEndpointListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsEndpointListResponse = DigitalTwinsEndpointResourceListResult;
+
+// @public
+export type DigitalTwinsEndpointResource = ExternalResource & {
+    properties: DigitalTwinsEndpointResourcePropertiesUnion;
+};
+
+// @public
+export interface DigitalTwinsEndpointResourceListResult {
+    nextLink?: string;
+    value?: DigitalTwinsEndpointResource[];
+}
+
+// @public
+export interface DigitalTwinsEndpointResourceProperties {
+    authenticationType?: AuthenticationType;
+    readonly createdTime?: Date;
+    deadLetterSecret?: string;
+    deadLetterUri?: string;
+    endpointType: "ServiceBus" | "EventHub" | "EventGrid";
+    readonly provisioningState?: EndpointProvisioningState;
+}
+
+// @public (undocumented)
+export type DigitalTwinsEndpointResourcePropertiesUnion = DigitalTwinsEndpointResourceProperties | ServiceBus | EventHub | EventGrid;
+
+// @public
+export interface DigitalTwinsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsGetResponse = DigitalTwinsDescription;
+
+// @public
+export interface DigitalTwinsIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: DigitalTwinsIdentityType;
+}
+
+// @public
+export type DigitalTwinsIdentityType = string;
+
+// @public
+export interface DigitalTwinsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsListByResourceGroupNextResponse = DigitalTwinsDescriptionListResult;
+
+// @public
+export interface DigitalTwinsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsListByResourceGroupResponse = DigitalTwinsDescriptionListResult;
+
+// @public
+export interface DigitalTwinsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsListNextResponse = DigitalTwinsDescriptionListResult;
+
+// @public
+export interface DigitalTwinsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DigitalTwinsListResponse = DigitalTwinsDescriptionListResult;
+
+// @public
+export interface DigitalTwinsPatchDescription {
+    identity?: DigitalTwinsIdentity;
+    properties?: DigitalTwinsPatchProperties;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface DigitalTwinsPatchProperties {
+    publicNetworkAccess?: PublicNetworkAccess;
+}
+
+// @public
+export interface DigitalTwinsResource {
+    readonly id?: string;
+    identity?: DigitalTwinsIdentity;
+    location: string;
+    readonly name?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface DigitalTwinsUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DigitalTwinsUpdateResponse = DigitalTwinsDescription;
+
+// @public
+export type EndpointProvisioningState = string;
+
+// @public
+export type EndpointType = string;
+
+// @public
+export interface ErrorDefinition {
+    readonly code?: string;
+    readonly details?: ErrorDefinition[];
+    readonly message?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDefinition;
+}
+
+// @public
+export type EventGrid = DigitalTwinsEndpointResourceProperties & {
+    endpointType: "EventGrid";
+    topicEndpoint: string;
+    accessKey1: string | null;
+    accessKey2?: string;
+};
+
+// @public
+export type EventHub = DigitalTwinsEndpointResourceProperties & {
+    endpointType: "EventHub";
+    connectionStringPrimaryKey?: string;
+    connectionStringSecondaryKey?: string;
+    endpointUri?: string;
+    entityPath?: string;
+};
+
+// @public
+export interface ExternalResource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface GroupIdInformation {
+    id?: string;
+    readonly name?: string;
+    // (undocumented)
+    properties: GroupIdInformationProperties;
+    readonly type?: string;
+}
+
+// @public (undocumented)
+export type GroupIdInformationProperties = GroupIdInformationPropertiesAutoGenerated & {};
+
+// @public
+export interface GroupIdInformationPropertiesAutoGenerated {
+    groupId?: string;
+    requiredMembers?: string[];
+    requiredZoneNames?: string[];
+}
+
+// @public
+export interface GroupIdInformationResponse {
+    value?: GroupIdInformation[];
+}
+
+// @public
+export enum KnownAuthenticationType {
+    // (undocumented)
+    IdentityBased = "IdentityBased",
+    // (undocumented)
+    KeyBased = "KeyBased"
+}
+
+// @public
+export enum KnownConnectionPropertiesProvisioningState {
+    // (undocumented)
+    Approved = "Approved",
+    // (undocumented)
+    Disconnected = "Disconnected",
+    // (undocumented)
+    Pending = "Pending",
+    // (undocumented)
+    Rejected = "Rejected"
+}
+
+// @public
+export enum KnownDigitalTwinsIdentityType {
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    SystemAssigned = "SystemAssigned"
+}
+
+// @public
+export enum KnownEndpointProvisioningState {
+    // (undocumented)
+    Canceled = "Canceled",
+    // (undocumented)
+    Deleted = "Deleted",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Moving = "Moving",
+    // (undocumented)
+    Provisioning = "Provisioning",
+    // (undocumented)
+    Restoring = "Restoring",
+    // (undocumented)
+    Succeeded = "Succeeded",
+    // (undocumented)
+    Suspending = "Suspending",
+    // (undocumented)
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownEndpointType {
+    // (undocumented)
+    EventGrid = "EventGrid",
+    // (undocumented)
+    EventHub = "EventHub",
+    // (undocumented)
+    ServiceBus = "ServiceBus"
+}
+
+// @public
+export enum KnownPrivateLinkServiceConnectionStatus {
+    // (undocumented)
+    Approved = "Approved",
+    // (undocumented)
+    Disconnected = "Disconnected",
+    // (undocumented)
+    Pending = "Pending",
+    // (undocumented)
+    Rejected = "Rejected"
+}
+
+// @public
+export enum KnownProvisioningState {
+    // (undocumented)
+    Canceled = "Canceled",
+    // (undocumented)
+    Deleted = "Deleted",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Moving = "Moving",
+    // (undocumented)
+    Provisioning = "Provisioning",
+    // (undocumented)
+    Restoring = "Restoring",
+    // (undocumented)
+    Succeeded = "Succeeded",
+    // (undocumented)
+    Suspending = "Suspending",
+    // (undocumented)
+    Updating = "Updating",
+    // (undocumented)
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownPublicNetworkAccess {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownReason {
+    // (undocumented)
+    AlreadyExists = "AlreadyExists",
+    // (undocumented)
+    Invalid = "Invalid"
+}
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export interface PrivateEndpoint {
+    readonly id?: string;
+}
+
+// @public
+export interface PrivateEndpointConnection {
+    readonly id?: string;
+    readonly name?: string;
+    // (undocumented)
+    properties: PrivateEndpointConnectionProperties;
+    readonly type?: string;
+}
+
+// @public (undocumented)
+export type PrivateEndpointConnectionProperties = ConnectionProperties & {};
+
+// @public
+export interface PrivateEndpointConnections {
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnectionsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
+    list(resourceGroupName: string, resourceName: string, options?: PrivateEndpointConnectionsListOptionalParams): Promise<PrivateEndpointConnectionsListResponse>;
+}
+
+// @public
+export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsListResponse = PrivateEndpointConnectionsResponse;
+
+// @public
+export interface PrivateEndpointConnectionsResponse {
+    value?: PrivateEndpointConnection[];
+}
+
+// @public
+export interface PrivateLinkResources {
+    get(resourceGroupName: string, resourceName: string, resourceId: string, options?: PrivateLinkResourcesGetOptionalParams): Promise<PrivateLinkResourcesGetResponse>;
+    list(resourceGroupName: string, resourceName: string, options?: PrivateLinkResourcesListOptionalParams): Promise<PrivateLinkResourcesListResponse>;
+}
+
+// @public
+export interface PrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateLinkResourcesGetResponse = GroupIdInformation;
+
+// @public
+export interface PrivateLinkResourcesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateLinkResourcesListResponse = GroupIdInformationResponse;
+
+// @public
+export type PrivateLinkServiceConnectionStatus = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export type PublicNetworkAccess = string;
+
+// @public
+export type Reason = string;
+
+// @public
+export type ServiceBus = DigitalTwinsEndpointResourceProperties & {
+    endpointType: "ServiceBus";
+    primaryConnectionString?: string;
+    secondaryConnectionString?: string;
+    endpointUri?: string;
+    entityPath?: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```