mirror of
https://github.com/hanzoai/azure-sdk-for-js.git
synced 2026-10-30 19:51:51 +00:00
Configurations: 'specification/networkfunction/resource-manager/Microsoft.NetworkFunction/TrafficCollector/tspconfig.yaml', API Version: 2022-11-01, SDK Release Type: beta, and CommitSHA: '3e0c16b4e69111860b9cb246f0eb64bd67ae6db1' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6485336 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. --------- Co-authored-by: Jiao Di (MSFT) <[email protected]>
13 KiB
13 KiB
API Report File for "@azure/arm-networkfunction"
Do not edit this file. It is a report generated by API Extractor.
import type { AbortSignalLike } from '@azure/abort-controller';
import type { CancelOnProgress } from '@azure/core-lro';
import type { ClientOptions } from '@azure-rest/core-client';
import { isRestError } from '@azure/core-rest-pipeline';
import type { OperationOptions } from '@azure-rest/core-client';
import type { OperationState } from '@azure/core-lro';
import type { PathUncheckedResponse } from '@azure-rest/core-client';
import type { Pipeline } from '@azure/core-rest-pipeline';
import type { PollerLike } from '@azure/core-lro';
import { RestError } from '@azure/core-rest-pipeline';
import type { TokenCredential } from '@azure/core-auth';
// @public
export enum AzureClouds {
AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
}
// @public
export type AzureSupportedClouds = `${AzureClouds}`;
// @public
export interface AzureTrafficCollector extends ProxyResource {
readonly collectorPolicies?: ResourceReference[];
readonly etag?: string;
location: string;
readonly provisioningState?: ProvisioningState;
tags?: Record<string, string>;
virtualHub?: ResourceReference;
}
// @public (undocumented)
export class AzureTrafficCollectorClient {
constructor(credential: TokenCredential, options?: AzureTrafficCollectorClientOptionalParams);
constructor(credential: TokenCredential, subscriptionId: string, options?: AzureTrafficCollectorClientOptionalParams);
readonly azureTrafficCollectors: AzureTrafficCollectorsOperations;
readonly azureTrafficCollectorsByResourceGroup: AzureTrafficCollectorsByResourceGroupOperations;
readonly azureTrafficCollectorsBySubscription: AzureTrafficCollectorsBySubscriptionOperations;
readonly collectorPolicies: CollectorPoliciesOperations;
readonly networkFunction: NetworkFunctionOperations;
readonly pipeline: Pipeline;
}
// @public
export interface AzureTrafficCollectorClientOptionalParams extends ClientOptions {
apiVersion?: string;
cloudSetting?: AzureSupportedClouds;
}
// @public
export interface AzureTrafficCollectorPropertiesFormat {
readonly collectorPolicies?: ResourceReference[];
readonly provisioningState?: ProvisioningState;
virtualHub?: ResourceReference;
}
// @public
export interface AzureTrafficCollectorsByResourceGroupListOptionalParams extends OperationOptions {
}
// @public
export interface AzureTrafficCollectorsByResourceGroupOperations {
list: (resourceGroupName: string, options?: AzureTrafficCollectorsByResourceGroupListOptionalParams) => PagedAsyncIterableIterator<AzureTrafficCollector>;
}
// @public
export interface AzureTrafficCollectorsBySubscriptionListOptionalParams extends OperationOptions {
}
// @public
export interface AzureTrafficCollectorsBySubscriptionOperations {
list: (options?: AzureTrafficCollectorsBySubscriptionListOptionalParams) => PagedAsyncIterableIterator<AzureTrafficCollector>;
}
// @public
export interface AzureTrafficCollectorsCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface AzureTrafficCollectorsDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface AzureTrafficCollectorsGetOptionalParams extends OperationOptions {
}
// @public
export interface AzureTrafficCollectorsOperations {
// @deprecated (undocumented)
beginCreateOrUpdate: (resourceGroupName: string, azureTrafficCollectorName: string, parameters: AzureTrafficCollector, options?: AzureTrafficCollectorsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<AzureTrafficCollector>, AzureTrafficCollector>>;
// @deprecated (undocumented)
beginCreateOrUpdateAndWait: (resourceGroupName: string, azureTrafficCollectorName: string, parameters: AzureTrafficCollector, options?: AzureTrafficCollectorsCreateOrUpdateOptionalParams) => Promise<AzureTrafficCollector>;
// @deprecated (undocumented)
beginDelete: (resourceGroupName: string, azureTrafficCollectorName: string, options?: AzureTrafficCollectorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginDeleteAndWait: (resourceGroupName: string, azureTrafficCollectorName: string, options?: AzureTrafficCollectorsDeleteOptionalParams) => Promise<void>;
createOrUpdate: (resourceGroupName: string, azureTrafficCollectorName: string, parameters: AzureTrafficCollector, options?: AzureTrafficCollectorsCreateOrUpdateOptionalParams) => PollerLike<OperationState<AzureTrafficCollector>, AzureTrafficCollector>;
delete: (resourceGroupName: string, azureTrafficCollectorName: string, options?: AzureTrafficCollectorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, azureTrafficCollectorName: string, options?: AzureTrafficCollectorsGetOptionalParams) => Promise<AzureTrafficCollector>;
updateTags: (resourceGroupName: string, azureTrafficCollectorName: string, parameters: TagsObject, options?: AzureTrafficCollectorsUpdateTagsOptionalParams) => Promise<AzureTrafficCollector>;
}
// @public
export interface AzureTrafficCollectorsUpdateTagsOptionalParams extends OperationOptions {
}
// @public
export interface CloudError {
error?: CloudErrorBody;
}
// @public
export interface CloudErrorBody {
code?: string;
details?: CloudErrorBody[];
message?: string;
target?: string;
}
// @public
export interface CollectorPoliciesCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CollectorPoliciesDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CollectorPoliciesGetOptionalParams extends OperationOptions {
}
// @public
export interface CollectorPoliciesListOptionalParams extends OperationOptions {
}
// @public
export interface CollectorPoliciesOperations {
// @deprecated (undocumented)
beginCreateOrUpdate: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, parameters: CollectorPolicy, options?: CollectorPoliciesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<CollectorPolicy>, CollectorPolicy>>;
// @deprecated (undocumented)
beginCreateOrUpdateAndWait: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, parameters: CollectorPolicy, options?: CollectorPoliciesCreateOrUpdateOptionalParams) => Promise<CollectorPolicy>;
// @deprecated (undocumented)
beginDelete: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginDeleteAndWait: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesDeleteOptionalParams) => Promise<void>;
createOrUpdate: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, parameters: CollectorPolicy, options?: CollectorPoliciesCreateOrUpdateOptionalParams) => PollerLike<OperationState<CollectorPolicy>, CollectorPolicy>;
delete: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, options?: CollectorPoliciesGetOptionalParams) => Promise<CollectorPolicy>;
list: (resourceGroupName: string, azureTrafficCollectorName: string, options?: CollectorPoliciesListOptionalParams) => PagedAsyncIterableIterator<CollectorPolicy>;
updateTags: (resourceGroupName: string, azureTrafficCollectorName: string, collectorPolicyName: string, parameters: TagsObject, options?: CollectorPoliciesUpdateTagsOptionalParams) => Promise<CollectorPolicy>;
}
// @public
export interface CollectorPoliciesUpdateTagsOptionalParams extends OperationOptions {
}
// @public
export interface CollectorPolicy extends ProxyResource {
emissionPolicies?: EmissionPoliciesPropertiesFormat[];
readonly etag?: string;
ingestionPolicy?: IngestionPolicyPropertiesFormat;
location: string;
readonly provisioningState?: ProvisioningState;
tags?: Record<string, string>;
}
// @public
export interface CollectorPolicyPropertiesFormat {
emissionPolicies?: EmissionPoliciesPropertiesFormat[];
ingestionPolicy?: IngestionPolicyPropertiesFormat;
readonly provisioningState?: ProvisioningState;
}
// @public
export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
continuationToken?: string;
};
// @public
export type CreatedByType = string;
// @public
export type DestinationType = string;
// @public
export interface EmissionPoliciesPropertiesFormat {
emissionDestinations?: EmissionPolicyDestination[];
emissionType?: EmissionType;
}
// @public
export interface EmissionPolicyDestination {
destinationType?: DestinationType;
}
// @public
export type EmissionType = string;
// @public
export interface IngestionPolicyPropertiesFormat {
ingestionSources?: IngestionSourcesPropertiesFormat[];
ingestionType?: IngestionType;
}
// @public
export interface IngestionSourcesPropertiesFormat {
resourceId?: string;
sourceType?: SourceType;
}
// @public
export type IngestionType = string;
export { isRestError }
// @public
export enum KnownCreatedByType {
Application = "Application",
Key = "Key",
ManagedIdentity = "ManagedIdentity",
User = "User"
}
// @public
export enum KnownDestinationType {
AzureMonitor = "AzureMonitor"
}
// @public
export enum KnownEmissionType {
Ipfix = "IPFIX"
}
// @public
export enum KnownIngestionType {
Ipfix = "IPFIX"
}
// @public
export enum KnownProvisioningState {
Deleting = "Deleting",
Failed = "Failed",
Succeeded = "Succeeded",
Updating = "Updating"
}
// @public
export enum KnownSourceType {
Resource = "Resource"
}
// @public
export enum KnownVersions {
V20221101 = "2022-11-01"
}
// @public
export interface NetworkFunctionListOperationsOptionalParams extends OperationOptions {
}
// @public
export interface NetworkFunctionOperations {
listOperations: (options?: NetworkFunctionListOperationsOptionalParams) => PagedAsyncIterableIterator<Operation>;
}
// @public
export interface Operation {
display?: OperationDisplay;
isDataAction?: boolean;
name?: string;
origin?: string;
}
// @public
export interface OperationDisplay {
description?: string;
operation?: string;
provider?: string;
resource?: 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 interface ResourceReference {
readonly id?: string;
}
export { RestError }
// @public
export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: AzureTrafficCollectorClient, 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 SimplePollerLike<TState extends OperationState<TResult>, TResult> {
getOperationState(): TState;
getResult(): TResult | undefined;
isDone(): boolean;
// @deprecated
isStopped(): boolean;
onProgress(callback: (state: TState) => void): CancelOnProgress;
poll(options?: {
abortSignal?: AbortSignalLike;
}): Promise<TState>;
pollUntilDone(pollOptions?: {
abortSignal?: AbortSignalLike;
}): Promise<TResult>;
serialize(): Promise<string>;
// @deprecated
stopPolling(): void;
submitted(): Promise<void>;
// @deprecated
toString(): string;
}
// @public
export type SourceType = string;
// @public
export interface SystemData {
createdAt?: Date;
createdBy?: string;
createdByType?: CreatedByType;
lastModifiedAt?: Date;
lastModifiedBy?: string;
lastModifiedByType?: CreatedByType;
}
// @public
export interface TagsObject {
tags?: Record<string, string>;
}
// (No @packageDocumentation comment for this package)