@azure/arm-domainservices 3.2.1 → 4.0.1-alpha.20220119.1

package/review/arm-domainservices.api.md

@@ -0,0 +1,591 @@
+## API Report File for "@azure/arm-domainservices"
+
+> 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 interface CloudError {
+    error?: CloudErrorBody;
+}
+
+// @public
+export interface CloudErrorBody {
+    code?: string;
+    details?: CloudErrorBody[];
+    message?: string;
+    target?: string;
+}
+
+// @public
+export interface ConfigDiagnostics {
+    lastExecuted?: Date;
+    validatorResults?: ConfigDiagnosticsValidatorResult[];
+}
+
+// @public
+export interface ConfigDiagnosticsValidatorResult {
+    issues?: ConfigDiagnosticsValidatorResultIssue[];
+    replicaSetSubnetDisplayName?: string;
+    status?: Status;
+    validatorId?: string;
+}
+
+// @public
+export interface ConfigDiagnosticsValidatorResultIssue {
+    descriptionParams?: string[];
+    id?: string;
+}
+
+// @public
+export interface ContainerAccount {
+    accountName?: string;
+    password?: string;
+    spn?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DomainSecuritySettings {
+    kerberosArmoring?: KerberosArmoring;
+    kerberosRc4Encryption?: KerberosRc4Encryption;
+    ntlmV1?: NtlmV1;
+    syncKerberosPasswords?: SyncKerberosPasswords;
+    syncNtlmPasswords?: SyncNtlmPasswords;
+    syncOnPremPasswords?: SyncOnPremPasswords;
+    tlsV1?: TlsV1;
+}
+
+// @public
+export type DomainService = Resource & {
+    readonly version?: number;
+    readonly tenantId?: string;
+    domainName?: string;
+    readonly deploymentId?: string;
+    readonly syncOwner?: string;
+    replicaSets?: ReplicaSet[];
+    ldapsSettings?: LdapsSettings;
+    resourceForestSettings?: ResourceForestSettings;
+    domainSecuritySettings?: DomainSecuritySettings;
+    domainConfigurationType?: string;
+    sku?: string;
+    filteredSync?: FilteredSync;
+    notificationSettings?: NotificationSettings;
+    readonly migrationProperties?: MigrationProperties;
+    readonly provisioningState?: string;
+    configDiagnostics?: ConfigDiagnostics;
+};
+
+// @public
+export interface DomainServiceListResult {
+    readonly nextLink?: string;
+    value?: DomainService[];
+}
+
+// @public
+export interface DomainServiceOperations {
+    list(options?: DomainServiceOperationsListOptionalParams): PagedAsyncIterableIterator<OperationEntity>;
+}
+
+// @public
+export interface DomainServiceOperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServiceOperationsListNextResponse = OperationEntityListResult;
+
+// @public
+export interface DomainServiceOperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServiceOperationsListResponse = OperationEntityListResult;
+
+// @public
+export interface DomainServices {
+    beginCreateOrUpdate(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainServicesCreateOrUpdateResponse>, DomainServicesCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesCreateOrUpdateOptionalParams): Promise<DomainServicesCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, domainServiceName: string, options?: DomainServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, domainServiceName: string, options?: DomainServicesDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainServicesUpdateResponse>, DomainServicesUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, domainServiceName: string, domainService: DomainService, options?: DomainServicesUpdateOptionalParams): Promise<DomainServicesUpdateResponse>;
+    get(resourceGroupName: string, domainServiceName: string, options?: DomainServicesGetOptionalParams): Promise<DomainServicesGetResponse>;
+    list(options?: DomainServicesListOptionalParams): PagedAsyncIterableIterator<DomainService>;
+    listByResourceGroup(resourceGroupName: string, options?: DomainServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DomainService>;
+}
+
+// @public
+export interface DomainServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DomainServicesCreateOrUpdateResponse = DomainService;
+
+// @public
+export interface DomainServicesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DomainServicesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServicesGetResponse = DomainService;
+
+// @public
+export interface DomainServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServicesListByResourceGroupNextResponse = DomainServiceListResult;
+
+// @public
+export interface DomainServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServicesListByResourceGroupResponse = DomainServiceListResult;
+
+// @public
+export interface DomainServicesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServicesListNextResponse = DomainServiceListResult;
+
+// @public
+export interface DomainServicesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DomainServicesListResponse = DomainServiceListResult;
+
+// @public (undocumented)
+export class DomainServicesResourceProvider extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DomainServicesResourceProviderOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    domainServiceOperations: DomainServiceOperations;
+    // (undocumented)
+    domainServices: DomainServices;
+    // (undocumented)
+    ouContainerOperationGrp: OuContainerOperationGrp;
+    // (undocumented)
+    ouContainerOperations: OuContainerOperations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface DomainServicesResourceProviderOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface DomainServicesUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DomainServicesUpdateResponse = DomainService;
+
+// @public
+export type ExternalAccess = string;
+
+// @public
+export type FilteredSync = string;
+
+// @public
+export interface ForestTrust {
+    friendlyName?: string;
+    remoteDnsIps?: string;
+    trustDirection?: string;
+    trustedDomainFqdn?: string;
+    trustPassword?: string;
+}
+
+// @public
+export interface HealthAlert {
+    readonly id?: string;
+    readonly issue?: string;
+    readonly lastDetected?: Date;
+    readonly name?: string;
+    readonly raised?: Date;
+    readonly resolutionUri?: string;
+    readonly severity?: string;
+}
+
+// @public
+export interface HealthMonitor {
+    readonly details?: string;
+    readonly id?: string;
+    readonly name?: string;
+}
+
+// @public
+export type KerberosArmoring = string;
+
+// @public
+export type KerberosRc4Encryption = string;
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownExternalAccess {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownFilteredSync {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownKerberosArmoring {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownKerberosRc4Encryption {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownLdaps {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownNotifyDcAdmins {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownNotifyGlobalAdmins {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownNtlmV1 {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownStatus {
+    // (undocumented)
+    Failure = "Failure",
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    OK = "OK",
+    // (undocumented)
+    Running = "Running",
+    // (undocumented)
+    Skipped = "Skipped",
+    // (undocumented)
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownSyncKerberosPasswords {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownSyncNtlmPasswords {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownSyncOnPremPasswords {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownTlsV1 {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export type Ldaps = string;
+
+// @public
+export interface LdapsSettings {
+    readonly certificateNotAfter?: Date;
+    readonly certificateThumbprint?: string;
+    externalAccess?: ExternalAccess;
+    ldaps?: Ldaps;
+    pfxCertificate?: string;
+    pfxCertificatePassword?: string;
+    readonly publicCertificate?: string;
+}
+
+// @public
+export interface MigrationProgress {
+    completionPercentage?: number;
+    progressMessage?: string;
+}
+
+// @public
+export interface MigrationProperties {
+    readonly migrationProgress?: MigrationProgress;
+    readonly oldSubnetId?: string;
+    readonly oldVnetSiteId?: string;
+}
+
+// @public
+export interface NotificationSettings {
+    additionalRecipients?: string[];
+    notifyDcAdmins?: NotifyDcAdmins;
+    notifyGlobalAdmins?: NotifyGlobalAdmins;
+}
+
+// @public
+export type NotifyDcAdmins = string;
+
+// @public
+export type NotifyGlobalAdmins = string;
+
+// @public
+export type NtlmV1 = string;
+
+// @public
+export interface OperationDisplayInfo {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationEntity {
+    display?: OperationDisplayInfo;
+    name?: string;
+    origin?: string;
+}
+
+// @public
+export interface OperationEntityListResult {
+    readonly nextLink?: string;
+    value?: OperationEntity[];
+}
+
+// @public
+export type OuContainer = Resource & {
+    readonly tenantId?: string;
+    readonly domainName?: string;
+    readonly deploymentId?: string;
+    readonly containerId?: string;
+    accounts?: ContainerAccount[];
+    readonly serviceStatus?: string;
+    readonly distinguishedName?: string;
+    readonly provisioningState?: string;
+};
+
+// @public
+export interface OuContainerCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type OuContainerCreateResponse = OuContainer;
+
+// @public
+export interface OuContainerDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OuContainerGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OuContainerGetResponse = OuContainer;
+
+// @public
+export interface OuContainerListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OuContainerListNextResponse = OuContainerListResult;
+
+// @public
+export interface OuContainerListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OuContainerListResponse = OuContainerListResult;
+
+// @public
+export interface OuContainerListResult {
+    readonly nextLink?: string;
+    value?: OuContainer[];
+}
+
+// @public
+export interface OuContainerOperationGrp {
+    beginCreate(resourceGroupName: string, domainServiceName: string, ouContainerName: string, containerAccount: ContainerAccount, options?: OuContainerCreateOptionalParams): Promise<PollerLike<PollOperationState<OuContainerCreateResponse>, OuContainerCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, domainServiceName: string, ouContainerName: string, containerAccount: ContainerAccount, options?: OuContainerCreateOptionalParams): Promise<OuContainerCreateResponse>;
+    beginDelete(resourceGroupName: string, domainServiceName: string, ouContainerName: string, options?: OuContainerDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, domainServiceName: string, ouContainerName: string, options?: OuContainerDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, domainServiceName: string, ouContainerName: string, containerAccount: ContainerAccount, options?: OuContainerUpdateOptionalParams): Promise<PollerLike<PollOperationState<OuContainerUpdateResponse>, OuContainerUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, domainServiceName: string, ouContainerName: string, containerAccount: ContainerAccount, options?: OuContainerUpdateOptionalParams): Promise<OuContainerUpdateResponse>;
+    get(resourceGroupName: string, domainServiceName: string, ouContainerName: string, options?: OuContainerGetOptionalParams): Promise<OuContainerGetResponse>;
+    list(resourceGroupName: string, domainServiceName: string, options?: OuContainerListOptionalParams): PagedAsyncIterableIterator<OuContainer>;
+}
+
+// @public
+export interface OuContainerOperations {
+    list(options?: OuContainerOperationsListOptionalParams): PagedAsyncIterableIterator<OperationEntity>;
+}
+
+// @public
+export interface OuContainerOperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OuContainerOperationsListNextResponse = OperationEntityListResult;
+
+// @public
+export interface OuContainerOperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OuContainerOperationsListResponse = OperationEntityListResult;
+
+// @public
+export interface OuContainerUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type OuContainerUpdateResponse = OuContainer;
+
+// @public
+export interface ReplicaSet {
+    readonly domainControllerIpAddress?: string[];
+    readonly externalAccessIpAddress?: string;
+    readonly healthAlerts?: HealthAlert[];
+    readonly healthLastEvaluated?: Date;
+    readonly healthMonitors?: HealthMonitor[];
+    location?: string;
+    readonly replicaSetId?: string;
+    readonly serviceStatus?: string;
+    subnetId?: string;
+    readonly vnetSiteId?: string;
+}
+
+// @public
+export interface Resource {
+    etag?: string;
+    readonly id?: string;
+    location?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceForestSettings {
+    resourceForest?: string;
+    settings?: ForestTrust[];
+}
+
+// @public
+export type Status = string;
+
+// @public
+export type SyncKerberosPasswords = string;
+
+// @public
+export type SyncNtlmPasswords = string;
+
+// @public
+export type SyncOnPremPasswords = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TlsV1 = string;
+
+// (No @packageDocumentation comment for this package)
+
+```