@azure/arm-deviceregistry 1.0.0 → 1.1.0

package/review/arm-deviceregistry.api.md

@@ -1,543 +0,0 @@
-## API Report File for "@azure/arm-deviceregistry"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { AbortSignalLike } from '@azure/abort-controller';
-import { ClientOptions } from '@azure-rest/core-client';
-import { OperationOptions } from '@azure-rest/core-client';
-import { OperationState } from '@azure/core-lro';
-import { PathUncheckedResponse } from '@azure-rest/core-client';
-import { Pipeline } from '@azure/core-rest-pipeline';
-import { PollerLike } from '@azure/core-lro';
-import { TokenCredential } from '@azure/core-auth';
-
-// @public
-export type ActionType = string;
-
-// @public
-export interface Asset extends TrackedResource {
-    extendedLocation: ExtendedLocation;
-    properties?: AssetProperties;
-}
-
-// @public
-export interface AssetEndpointProfile extends TrackedResource {
-    extendedLocation: ExtendedLocation;
-    properties?: AssetEndpointProfileProperties;
-}
-
-// @public
-export interface AssetEndpointProfileProperties {
-    additionalConfiguration?: string;
-    authentication?: Authentication;
-    discoveredAssetEndpointProfileRef?: string;
-    endpointProfileType: string;
-    readonly provisioningState?: ProvisioningState;
-    readonly status?: AssetEndpointProfileStatus;
-    targetAddress: string;
-    readonly uuid?: string;
-}
-
-// @public
-export interface AssetEndpointProfilesCreateOrReplaceOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface AssetEndpointProfilesDeleteOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface AssetEndpointProfilesGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface AssetEndpointProfilesListByResourceGroupOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface AssetEndpointProfilesListBySubscriptionOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface AssetEndpointProfilesOperations {
-    createOrReplace: (resourceGroupName: string, assetEndpointProfileName: string, resource: AssetEndpointProfile, options?: AssetEndpointProfilesCreateOrReplaceOptionalParams) => PollerLike<OperationState<AssetEndpointProfile>, AssetEndpointProfile>;
-    delete: (resourceGroupName: string, assetEndpointProfileName: string, options?: AssetEndpointProfilesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
-    get: (resourceGroupName: string, assetEndpointProfileName: string, options?: AssetEndpointProfilesGetOptionalParams) => Promise<AssetEndpointProfile>;
-    listByResourceGroup: (resourceGroupName: string, options?: AssetEndpointProfilesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<AssetEndpointProfile>;
-    listBySubscription: (options?: AssetEndpointProfilesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<AssetEndpointProfile>;
-    update: (resourceGroupName: string, assetEndpointProfileName: string, properties: AssetEndpointProfileUpdate, options?: AssetEndpointProfilesUpdateOptionalParams) => PollerLike<OperationState<AssetEndpointProfile>, AssetEndpointProfile>;
-}
-
-// @public
-export interface AssetEndpointProfileStatus {
-    readonly errors?: AssetEndpointProfileStatusError[];
-}
-
-// @public
-export interface AssetEndpointProfileStatusError {
-    readonly code?: number;
-    readonly message?: string;
-}
-
-// @public
-export interface AssetEndpointProfilesUpdateOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface AssetEndpointProfileUpdate {
-    properties?: AssetEndpointProfileUpdateProperties;
-    tags?: Record<string, string>;
-}
-
-// @public
-export interface AssetEndpointProfileUpdateProperties {
-    additionalConfiguration?: string;
-    authentication?: Authentication;
-    endpointProfileType?: string;
-    targetAddress?: string;
-}
-
-// @public
-export interface AssetProperties {
-    assetEndpointProfileRef: string;
-    attributes?: Record<string, any>;
-    datasets?: Dataset[];
-    defaultDatasetsConfiguration?: string;
-    defaultEventsConfiguration?: string;
-    defaultTopic?: Topic;
-    description?: string;
-    discoveredAssetRefs?: string[];
-    displayName?: string;
-    documentationUri?: string;
-    enabled?: boolean;
-    events?: Event_2[];
-    externalAssetId?: string;
-    hardwareRevision?: string;
-    manufacturer?: string;
-    manufacturerUri?: string;
-    model?: string;
-    productCode?: string;
-    readonly provisioningState?: ProvisioningState;
-    serialNumber?: string;
-    softwareRevision?: string;
-    readonly status?: AssetStatus;
-    readonly uuid?: string;
-    readonly version?: number;
-}
-
-// @public
-export interface AssetsCreateOrReplaceOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface AssetsDeleteOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface AssetsGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface AssetsListByResourceGroupOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface AssetsListBySubscriptionOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface AssetsOperations {
-    createOrReplace: (resourceGroupName: string, assetName: string, resource: Asset, options?: AssetsCreateOrReplaceOptionalParams) => PollerLike<OperationState<Asset>, Asset>;
-    delete: (resourceGroupName: string, assetName: string, options?: AssetsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
-    get: (resourceGroupName: string, assetName: string, options?: AssetsGetOptionalParams) => Promise<Asset>;
-    listByResourceGroup: (resourceGroupName: string, options?: AssetsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Asset>;
-    listBySubscription: (options?: AssetsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Asset>;
-    update: (resourceGroupName: string, assetName: string, properties: AssetUpdate, options?: AssetsUpdateOptionalParams) => PollerLike<OperationState<Asset>, Asset>;
-}
-
-// @public
-export interface AssetStatus {
-    readonly datasets?: AssetStatusDataset[];
-    readonly errors?: AssetStatusError[];
-    readonly events?: AssetStatusEvent[];
-    readonly version?: number;
-}
-
-// @public
-export interface AssetStatusDataset {
-    readonly messageSchemaReference?: MessageSchemaReference;
-    readonly name: string;
-}
-
-// @public
-export interface AssetStatusError {
-    readonly code?: number;
-    readonly message?: string;
-}
-
-// @public
-export interface AssetStatusEvent {
-    readonly messageSchemaReference?: MessageSchemaReference;
-    readonly name: string;
-}
-
-// @public
-export interface AssetsUpdateOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface AssetUpdate {
-    properties?: AssetUpdateProperties;
-    tags?: Record<string, string>;
-}
-
-// @public
-export interface AssetUpdateProperties {
-    attributes?: Record<string, any>;
-    datasets?: Dataset[];
-    defaultDatasetsConfiguration?: string;
-    defaultEventsConfiguration?: string;
-    defaultTopic?: Topic;
-    description?: string;
-    displayName?: string;
-    documentationUri?: string;
-    enabled?: boolean;
-    events?: Event_2[];
-    hardwareRevision?: string;
-    manufacturer?: string;
-    manufacturerUri?: string;
-    model?: string;
-    productCode?: string;
-    serialNumber?: string;
-    softwareRevision?: string;
-}
-
-// @public
-export interface Authentication {
-    method: AuthenticationMethod;
-    usernamePasswordCredentials?: UsernamePasswordCredentials;
-    x509Credentials?: X509Credentials;
-}
-
-// @public
-export type AuthenticationMethod = string;
-
-// @public
-export interface BillingContainer extends ProxyResource {
-    readonly etag?: string;
-    properties?: BillingContainerProperties;
-}
-
-// @public
-export interface BillingContainerProperties {
-    readonly provisioningState?: ProvisioningState;
-}
-
-// @public
-export interface BillingContainersGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface BillingContainersListBySubscriptionOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface BillingContainersOperations {
-    get: (billingContainerName: string, options?: BillingContainersGetOptionalParams) => Promise<BillingContainer>;
-    listBySubscription: (options?: BillingContainersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<BillingContainer>;
-}
-
-// @public
-export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
-    continuationToken?: string;
-};
-
-// @public
-export type CreatedByType = string;
-
-// @public
-export interface DataPoint extends DataPointBase {
-    observabilityMode?: DataPointObservabilityMode;
-}
-
-// @public
-export interface DataPointBase {
-    dataPointConfiguration?: string;
-    dataSource: string;
-    name: string;
-}
-
-// @public
-export type DataPointObservabilityMode = string;
-
-// @public
-export interface Dataset {
-    dataPoints?: DataPoint[];
-    datasetConfiguration?: string;
-    name: string;
-    topic?: Topic;
-}
-
-// @public (undocumented)
-export class DeviceRegistryManagementClient {
-    constructor(credential: TokenCredential, subscriptionId: string, options?: DeviceRegistryManagementClientOptionalParams);
-    readonly assetEndpointProfiles: AssetEndpointProfilesOperations;
-    readonly assets: AssetsOperations;
-    readonly billingContainers: BillingContainersOperations;
-    readonly operations: OperationsOperations;
-    readonly operationStatus: OperationStatusOperations;
-    readonly pipeline: Pipeline;
-}
-
-// @public
-export interface DeviceRegistryManagementClientOptionalParams extends ClientOptions {
-    apiVersion?: string;
-}
-
-// @public
-export interface ErrorAdditionalInfo {
-    readonly info?: Record<string, any>;
-    readonly type?: string;
-}
-
-// @public
-export interface ErrorDetail {
-    readonly additionalInfo?: ErrorAdditionalInfo[];
-    readonly code?: string;
-    readonly details?: ErrorDetail[];
-    readonly message?: string;
-    readonly target?: string;
-}
-
-// @public
-export interface ErrorResponse {
-    error?: ErrorDetail;
-}
-
-// @public
-interface Event_2 extends EventBase {
-    observabilityMode?: EventObservabilityMode;
-}
-export { Event_2 as Event }
-
-// @public
-export interface EventBase {
-    eventConfiguration?: string;
-    eventNotifier: string;
-    name: string;
-    topic?: Topic;
-}
-
-// @public
-export type EventObservabilityMode = string;
-
-// @public
-export interface ExtendedLocation {
-    name: string;
-    type: string;
-}
-
-// @public
-export enum KnownActionType {
-    Internal = "Internal"
-}
-
-// @public
-export enum KnownAuthenticationMethod {
-    Anonymous = "Anonymous",
-    Certificate = "Certificate",
-    UsernamePassword = "UsernamePassword"
-}
-
-// @public
-export enum KnownCreatedByType {
-    Application = "Application",
-    Key = "Key",
-    ManagedIdentity = "ManagedIdentity",
-    User = "User"
-}
-
-// @public
-export enum KnownDataPointObservabilityMode {
-    Counter = "Counter",
-    Gauge = "Gauge",
-    Histogram = "Histogram",
-    Log = "Log",
-    None = "None"
-}
-
-// @public
-export enum KnownEventObservabilityMode {
-    Log = "Log",
-    None = "None"
-}
-
-// @public
-export enum KnownOrigin {
-    System = "system",
-    User = "user",
-    UserSystem = "user,system"
-}
-
-// @public
-export enum KnownProvisioningState {
-    Accepted = "Accepted",
-    Canceled = "Canceled",
-    Deleting = "Deleting",
-    Failed = "Failed",
-    Succeeded = "Succeeded"
-}
-
-// @public
-export enum KnownTopicRetainType {
-    Keep = "Keep",
-    Never = "Never"
-}
-
-// @public
-export enum KnownVersions {
-    V20241101 = "2024-11-01"
-}
-
-// @public
-export interface MessageSchemaReference {
-    readonly schemaName: string;
-    readonly schemaRegistryNamespace: string;
-    readonly schemaVersion: string;
-}
-
-// @public
-export interface Operation {
-    readonly actionType?: ActionType;
-    display?: OperationDisplay;
-    readonly isDataAction?: boolean;
-    readonly name?: string;
-    readonly origin?: Origin;
-}
-
-// @public
-export interface OperationDisplay {
-    readonly description?: string;
-    readonly operation?: string;
-    readonly provider?: string;
-    readonly resource?: string;
-}
-
-// @public
-export interface OperationsListOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface OperationsOperations {
-    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
-}
-
-// @public
-export interface OperationStatusGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface OperationStatusOperations {
-    get: (location: string, operationId: string, options?: OperationStatusGetOptionalParams) => Promise<OperationStatusResult>;
-}
-
-// @public
-export interface OperationStatusResult {
-    endTime?: Date;
-    error?: ErrorDetail;
-    id?: string;
-    name?: string;
-    operations?: OperationStatusResult[];
-    percentComplete?: number;
-    readonly resourceId?: string;
-    startTime?: Date;
-    status: string;
-}
-
-// @public
-export type Origin = string;
-
-// @public
-export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
-    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
-    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
-    next(): Promise<IteratorResult<TElement>>;
-}
-
-// @public
-export interface PageSettings {
-    continuationToken?: string;
-}
-
-// @public
-export type ProvisioningState = string;
-
-// @public
-export interface ProxyResource extends Resource {
-}
-
-// @public
-export interface Resource {
-    readonly id?: string;
-    readonly name?: string;
-    readonly systemData?: SystemData;
-    readonly type?: string;
-}
-
-// @public
-export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: DeviceRegistryManagementClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
-
-// @public (undocumented)
-export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
-    abortSignal?: AbortSignalLike;
-    processResponseBody?: (result: TResponse) => Promise<TResult>;
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface SystemData {
-    createdAt?: Date;
-    createdBy?: string;
-    createdByType?: CreatedByType;
-    lastModifiedAt?: Date;
-    lastModifiedBy?: string;
-    lastModifiedByType?: CreatedByType;
-}
-
-// @public
-export interface Topic {
-    path: string;
-    retain?: TopicRetainType;
-}
-
-// @public
-export type TopicRetainType = string;
-
-// @public
-export interface TrackedResource extends Resource {
-    location: string;
-    tags?: Record<string, string>;
-}
-
-// @public
-export interface UsernamePasswordCredentials {
-    passwordSecretName: string;
-    usernameSecretName: string;
-}
-
-// @public
-export interface X509Credentials {
-    certificateSecretName: string;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```