@azure/arm-azureadexternalidentities 1.0.4-alpha.20250718.1 → 1.0.4-alpha.20250721.1

package/review/arm-azureadexternalidentities-node.api.md

@@ -1,381 +1,381 @@
-## API Report File for "@azure/arm-azureadexternalidentities"
-
-> 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 AvailableOperations {
-    nextLink?: string;
-    value?: OperationDetail[];
-}
-
-// @public
-export interface B2CResourceSKU {
-    name?: B2CResourceSKUName;
-    tier?: B2CResourceSKUTier;
-}
-
-// @public
-export type B2CResourceSKUName = string;
-
-// @public
-export type B2CResourceSKUTier = string;
-
-// @public (undocumented)
-export interface B2CTenantResource {
-    billingConfig?: B2CTenantResourcePropertiesBillingConfig;
-    readonly id?: string;
-    location: string;
-    readonly name?: string;
-    sku: B2CResourceSKU;
-    readonly systemData?: SystemData;
-    tags?: {
-        [propertyName: string]: string;
-    };
-    tenantId?: string;
-    readonly type?: TypeValue;
-}
-
-// @public
-export interface B2CTenantResourceList {
-    readonly value?: B2CTenantResource[];
-}
-
-// @public
-export interface B2CTenantResourcePropertiesBillingConfig {
-    billingType?: BillingType;
-    readonly effectiveStartDateUtc?: string;
-}
-
-// @public
-export interface B2CTenants {
-    beginCreate(resourceGroupName: string, resourceName: string, options?: B2CTenantsCreateOptionalParams): Promise<PollerLike<PollOperationState<B2CTenantsCreateResponse>, B2CTenantsCreateResponse>>;
-    beginCreateAndWait(resourceGroupName: string, resourceName: string, options?: B2CTenantsCreateOptionalParams): Promise<B2CTenantsCreateResponse>;
-    beginDelete(resourceGroupName: string, resourceName: string, options?: B2CTenantsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
-    beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: B2CTenantsDeleteOptionalParams): Promise<void>;
-    checkNameAvailability(options?: B2CTenantsCheckNameAvailabilityOptionalParams): Promise<B2CTenantsCheckNameAvailabilityResponse>;
-    get(resourceGroupName: string, resourceName: string, options?: B2CTenantsGetOptionalParams): Promise<B2CTenantsGetResponse>;
-    listByResourceGroup(resourceGroupName: string, options?: B2CTenantsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<B2CTenantResource>;
-    listBySubscription(options?: B2CTenantsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<B2CTenantResource>;
-    update(resourceGroupName: string, resourceName: string, options?: B2CTenantsUpdateOptionalParams): Promise<B2CTenantsUpdateResponse>;
-}
-
-// @public
-export interface B2CTenantsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
-    checkNameAvailabilityRequestBody?: CheckNameAvailabilityRequestBody;
-}
-
-// @public
-export type B2CTenantsCheckNameAvailabilityResponse = NameAvailabilityResponse;
-
-// @public
-export interface B2CTenantsCreateHeaders {
-    location?: string;
-    retryAfter?: string;
-}
-
-// @public
-export interface B2CTenantsCreateOptionalParams extends coreClient.OperationOptions {
-    createTenantRequestBody?: CreateTenantRequestBody;
-    resumeFrom?: string;
-    updateIntervalInMs?: number;
-}
-
-// @public
-export type B2CTenantsCreateResponse = B2CTenantResource;
-
-// @public
-export interface B2CTenantsDeleteHeaders {
-    location?: string;
-    retryAfter?: string;
-}
-
-// @public
-export interface B2CTenantsDeleteOptionalParams extends coreClient.OperationOptions {
-    resumeFrom?: string;
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface B2CTenantsGetOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type B2CTenantsGetResponse = B2CTenantResource;
-
-// @public
-export interface B2CTenantsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type B2CTenantsListByResourceGroupResponse = B2CTenantResourceList;
-
-// @public
-export interface B2CTenantsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type B2CTenantsListBySubscriptionResponse = B2CTenantResourceList;
-
-// @public
-export interface B2CTenantsUpdateOptionalParams extends coreClient.OperationOptions {
-    updateTenantRequestBody?: B2CTenantUpdateRequest;
-}
-
-// @public
-export type B2CTenantsUpdateResponse = B2CTenantResource;
-
-// @public
-export interface B2CTenantUpdateRequest {
-    billingConfig?: B2CTenantResourcePropertiesBillingConfig;
-    sku?: B2CResourceSKU;
-    tags?: {
-        [propertyName: string]: string;
-    };
-    tenantId?: string;
-}
-
-// @public
-export type BillingType = string;
-
-// @public
-export interface CheckNameAvailabilityRequestBody {
-    countryCode: string;
-    name: string;
-}
-
-// @public
-export interface CloudError {
-    error?: ErrorResponse;
-}
-
-// @public
-export type CreatedByType = string;
-
-// @public
-export interface CreateTenantRequestBody {
-    countryCode?: string;
-    displayName?: string;
-    location: string;
-    sku: B2CResourceSKU;
-    tags?: {
-        [propertyName: string]: string;
-    };
-}
-
-// @public
-export interface ErrorAdditionalInfo {
-    readonly info?: Record<string, unknown>;
-    readonly type?: string;
-}
-
-// @public
-export interface ErrorResponse {
-    readonly additionalInfo?: ErrorAdditionalInfo[];
-    readonly code?: string;
-    readonly details?: ErrorResponse[];
-    readonly message?: string;
-    readonly target?: string;
-}
-
-// @public (undocumented)
-export class ExternalIdentitiesConfigurationClient extends coreClient.ServiceClient {
-    // (undocumented)
-    $host: string;
-    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ExternalIdentitiesConfigurationClientOptionalParams);
-    // (undocumented)
-    apiVersion: string;
-    // (undocumented)
-    b2CTenants: B2CTenants;
-    // (undocumented)
-    guestUsages: GuestUsages;
-    // (undocumented)
-    operations: Operations;
-    // (undocumented)
-    subscriptionId: string;
-}
-
-// @public
-export interface ExternalIdentitiesConfigurationClientOptionalParams extends coreClient.ServiceClientOptions {
-    $host?: string;
-    apiVersion?: string;
-    endpoint?: string;
-}
-
-// @public
-export function getContinuationToken(page: unknown): string | undefined;
-
-// @public
-export interface GuestUsages {
-    create(resourceGroupName: string, resourceName: string, options?: GuestUsagesCreateOptionalParams): Promise<GuestUsagesCreateResponse>;
-    delete(resourceGroupName: string, resourceName: string, options?: GuestUsagesDeleteOptionalParams): Promise<void>;
-    get(resourceGroupName: string, resourceName: string, options?: GuestUsagesGetOptionalParams): Promise<GuestUsagesGetResponse>;
-    listByResourceGroup(resourceGroupName: string, options?: GuestUsagesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GuestUsagesResource>;
-    listBySubscription(options?: GuestUsagesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<GuestUsagesResource>;
-    update(resourceGroupName: string, resourceName: string, options?: GuestUsagesUpdateOptionalParams): Promise<GuestUsagesUpdateResponse>;
-}
-
-// @public
-export interface GuestUsagesCreateOptionalParams extends coreClient.OperationOptions {
-    resource?: GuestUsagesResource;
-}
-
-// @public
-export type GuestUsagesCreateResponse = GuestUsagesResource;
-
-// @public
-export interface GuestUsagesDeleteOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export interface GuestUsagesGetOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type GuestUsagesGetResponse = GuestUsagesResource;
-
-// @public
-export interface GuestUsagesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type GuestUsagesListByResourceGroupResponse = GuestUsagesResourceList;
-
-// @public
-export interface GuestUsagesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type GuestUsagesListBySubscriptionResponse = GuestUsagesResourceList;
-
-// @public
-export interface GuestUsagesResource {
-    readonly id?: string;
-    location?: string;
-    readonly name?: string;
-    readonly systemData?: SystemData;
-    tags?: {
-        [propertyName: string]: string;
-    };
-    tenantId?: string;
-    readonly type?: string;
-}
-
-// @public
-export interface GuestUsagesResourceList {
-    readonly value?: GuestUsagesResource[];
-}
-
-// @public
-export interface GuestUsagesResourcePatch {
-    tags?: {
-        [propertyName: string]: string;
-    };
-}
-
-// @public
-export interface GuestUsagesUpdateOptionalParams extends coreClient.OperationOptions {
-    resourcePatch?: GuestUsagesResourcePatch;
-}
-
-// @public
-export type GuestUsagesUpdateResponse = GuestUsagesResource;
-
-// @public
-export enum KnownB2CResourceSKUName {
-    PremiumP1 = "PremiumP1",
-    PremiumP2 = "PremiumP2",
-    Standard = "Standard"
-}
-
-// @public
-export enum KnownB2CResourceSKUTier {
-    A0 = "A0"
-}
-
-// @public
-export enum KnownBillingType {
-    Auths = "Auths",
-    MAU = "MAU"
-}
-
-// @public
-export enum KnownCreatedByType {
-    Application = "Application",
-    Key = "Key",
-    ManagedIdentity = "ManagedIdentity",
-    User = "User"
-}
-
-// @public
-export enum KnownNameAvailabilityReasonType {
-    AlreadyExists = "AlreadyExists",
-    Invalid = "Invalid"
-}
-
-// @public
-export enum KnownTypeValue {
-    MicrosoftAzureActiveDirectoryB2CDirectories = "Microsoft.AzureActiveDirectory/b2cDirectories"
-}
-
-// @public
-export type NameAvailabilityReasonType = string;
-
-// @public
-export interface NameAvailabilityResponse {
-    message?: string;
-    nameAvailable?: boolean;
-    reason?: NameAvailabilityReasonType;
-}
-
-// @public
-export interface OperationDetail {
-    display?: OperationDisplay;
-    isDataAction?: boolean;
-    name?: string;
-    origin?: string;
-}
-
-// @public
-export interface OperationDisplay {
-    description?: string;
-    operation?: string;
-    provider?: string;
-    resource?: string;
-}
-
-// @public
-export interface Operations {
-    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
-}
-
-// @public
-export interface OperationsListOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type OperationsListResponse = AvailableOperations;
-
-// @public
-export interface SystemData {
-    createdAt?: Date;
-    createdBy?: string;
-    createdByType?: CreatedByType;
-    lastModifiedAt?: Date;
-    lastModifiedBy?: string;
-    lastModifiedByType?: CreatedByType;
-}
-
-// @public
-export type TypeValue = string;
-
-// (No @packageDocumentation comment for this package)
-
-```
+## API Report File for "@azure/arm-azureadexternalidentities"
+
+> 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 AvailableOperations {
+    nextLink?: string;
+    value?: OperationDetail[];
+}
+
+// @public
+export interface B2CResourceSKU {
+    name?: B2CResourceSKUName;
+    tier?: B2CResourceSKUTier;
+}
+
+// @public
+export type B2CResourceSKUName = string;
+
+// @public
+export type B2CResourceSKUTier = string;
+
+// @public (undocumented)
+export interface B2CTenantResource {
+    billingConfig?: B2CTenantResourcePropertiesBillingConfig;
+    readonly id?: string;
+    location: string;
+    readonly name?: string;
+    sku: B2CResourceSKU;
+    readonly systemData?: SystemData;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    tenantId?: string;
+    readonly type?: TypeValue;
+}
+
+// @public
+export interface B2CTenantResourceList {
+    readonly value?: B2CTenantResource[];
+}
+
+// @public
+export interface B2CTenantResourcePropertiesBillingConfig {
+    billingType?: BillingType;
+    readonly effectiveStartDateUtc?: string;
+}
+
+// @public
+export interface B2CTenants {
+    beginCreate(resourceGroupName: string, resourceName: string, options?: B2CTenantsCreateOptionalParams): Promise<PollerLike<PollOperationState<B2CTenantsCreateResponse>, B2CTenantsCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, resourceName: string, options?: B2CTenantsCreateOptionalParams): Promise<B2CTenantsCreateResponse>;
+    beginDelete(resourceGroupName: string, resourceName: string, options?: B2CTenantsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: B2CTenantsDeleteOptionalParams): Promise<void>;
+    checkNameAvailability(options?: B2CTenantsCheckNameAvailabilityOptionalParams): Promise<B2CTenantsCheckNameAvailabilityResponse>;
+    get(resourceGroupName: string, resourceName: string, options?: B2CTenantsGetOptionalParams): Promise<B2CTenantsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: B2CTenantsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<B2CTenantResource>;
+    listBySubscription(options?: B2CTenantsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<B2CTenantResource>;
+    update(resourceGroupName: string, resourceName: string, options?: B2CTenantsUpdateOptionalParams): Promise<B2CTenantsUpdateResponse>;
+}
+
+// @public
+export interface B2CTenantsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+    checkNameAvailabilityRequestBody?: CheckNameAvailabilityRequestBody;
+}
+
+// @public
+export type B2CTenantsCheckNameAvailabilityResponse = NameAvailabilityResponse;
+
+// @public
+export interface B2CTenantsCreateHeaders {
+    location?: string;
+    retryAfter?: string;
+}
+
+// @public
+export interface B2CTenantsCreateOptionalParams extends coreClient.OperationOptions {
+    createTenantRequestBody?: CreateTenantRequestBody;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type B2CTenantsCreateResponse = B2CTenantResource;
+
+// @public
+export interface B2CTenantsDeleteHeaders {
+    location?: string;
+    retryAfter?: string;
+}
+
+// @public
+export interface B2CTenantsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface B2CTenantsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type B2CTenantsGetResponse = B2CTenantResource;
+
+// @public
+export interface B2CTenantsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type B2CTenantsListByResourceGroupResponse = B2CTenantResourceList;
+
+// @public
+export interface B2CTenantsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type B2CTenantsListBySubscriptionResponse = B2CTenantResourceList;
+
+// @public
+export interface B2CTenantsUpdateOptionalParams extends coreClient.OperationOptions {
+    updateTenantRequestBody?: B2CTenantUpdateRequest;
+}
+
+// @public
+export type B2CTenantsUpdateResponse = B2CTenantResource;
+
+// @public
+export interface B2CTenantUpdateRequest {
+    billingConfig?: B2CTenantResourcePropertiesBillingConfig;
+    sku?: B2CResourceSKU;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    tenantId?: string;
+}
+
+// @public
+export type BillingType = string;
+
+// @public
+export interface CheckNameAvailabilityRequestBody {
+    countryCode: string;
+    name: string;
+}
+
+// @public
+export interface CloudError {
+    error?: ErrorResponse;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface CreateTenantRequestBody {
+    countryCode?: string;
+    displayName?: string;
+    location: string;
+    sku: B2CResourceSKU;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorResponse[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public (undocumented)
+export class ExternalIdentitiesConfigurationClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ExternalIdentitiesConfigurationClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    b2CTenants: B2CTenants;
+    // (undocumented)
+    guestUsages: GuestUsages;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface ExternalIdentitiesConfigurationClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface GuestUsages {
+    create(resourceGroupName: string, resourceName: string, options?: GuestUsagesCreateOptionalParams): Promise<GuestUsagesCreateResponse>;
+    delete(resourceGroupName: string, resourceName: string, options?: GuestUsagesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, resourceName: string, options?: GuestUsagesGetOptionalParams): Promise<GuestUsagesGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: GuestUsagesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GuestUsagesResource>;
+    listBySubscription(options?: GuestUsagesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<GuestUsagesResource>;
+    update(resourceGroupName: string, resourceName: string, options?: GuestUsagesUpdateOptionalParams): Promise<GuestUsagesUpdateResponse>;
+}
+
+// @public
+export interface GuestUsagesCreateOptionalParams extends coreClient.OperationOptions {
+    resource?: GuestUsagesResource;
+}
+
+// @public
+export type GuestUsagesCreateResponse = GuestUsagesResource;
+
+// @public
+export interface GuestUsagesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface GuestUsagesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestUsagesGetResponse = GuestUsagesResource;
+
+// @public
+export interface GuestUsagesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestUsagesListByResourceGroupResponse = GuestUsagesResourceList;
+
+// @public
+export interface GuestUsagesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestUsagesListBySubscriptionResponse = GuestUsagesResourceList;
+
+// @public
+export interface GuestUsagesResource {
+    readonly id?: string;
+    location?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface GuestUsagesResourceList {
+    readonly value?: GuestUsagesResource[];
+}
+
+// @public
+export interface GuestUsagesResourcePatch {
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface GuestUsagesUpdateOptionalParams extends coreClient.OperationOptions {
+    resourcePatch?: GuestUsagesResourcePatch;
+}
+
+// @public
+export type GuestUsagesUpdateResponse = GuestUsagesResource;
+
+// @public
+export enum KnownB2CResourceSKUName {
+    PremiumP1 = "PremiumP1",
+    PremiumP2 = "PremiumP2",
+    Standard = "Standard"
+}
+
+// @public
+export enum KnownB2CResourceSKUTier {
+    A0 = "A0"
+}
+
+// @public
+export enum KnownBillingType {
+    Auths = "Auths",
+    MAU = "MAU"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownNameAvailabilityReasonType {
+    AlreadyExists = "AlreadyExists",
+    Invalid = "Invalid"
+}
+
+// @public
+export enum KnownTypeValue {
+    MicrosoftAzureActiveDirectoryB2CDirectories = "Microsoft.AzureActiveDirectory/b2cDirectories"
+}
+
+// @public
+export type NameAvailabilityReasonType = string;
+
+// @public
+export interface NameAvailabilityResponse {
+    message?: string;
+    nameAvailable?: boolean;
+    reason?: NameAvailabilityReasonType;
+}
+
+// @public
+export interface OperationDetail {
+    display?: OperationDisplay;
+    isDataAction?: boolean;
+    name?: string;
+    origin?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = AvailableOperations;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TypeValue = string;
+
+// (No @packageDocumentation comment for this package)
+
+```