@azure/arm-networkfunction 2.0.2-alpha.20260306.1 → 3.0.0-beta.1

package/dist/esm/models/models.d.ts

@@ -0,0 +1,335 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** Azure Traffic Collector resource. */
+export interface AzureTrafficCollector extends ProxyResource {
+    /** Resource location. */
+    location: string;
+    /** Resource tags. */
+    tags?: Record<string, string>;
+    /** A unique read-only string that changes whenever the resource is updated. */
+    readonly etag?: string;
+    /** Collector Policies for Azure Traffic Collector. */
+    readonly collectorPolicies?: ResourceReference[];
+    /** The virtualHub to which the Azure Traffic Collector belongs. */
+    virtualHub?: ResourceReference;
+    /** The provisioning state of the application rule collection resource. */
+    readonly provisioningState?: ProvisioningState;
+}
+export declare function azureTrafficCollectorSerializer(item: AzureTrafficCollector): any;
+export declare function azureTrafficCollectorDeserializer(item: any): AzureTrafficCollector;
+/** Azure Traffic Collector resource properties. */
+export interface AzureTrafficCollectorPropertiesFormat {
+    /** Collector Policies for Azure Traffic Collector. */
+    readonly collectorPolicies?: ResourceReference[];
+    /** The virtualHub to which the Azure Traffic Collector belongs. */
+    virtualHub?: ResourceReference;
+    /** The provisioning state of the application rule collection resource. */
+    readonly provisioningState?: ProvisioningState;
+}
+export declare function azureTrafficCollectorPropertiesFormatSerializer(item: AzureTrafficCollectorPropertiesFormat): any;
+export declare function azureTrafficCollectorPropertiesFormatDeserializer(item: any): AzureTrafficCollectorPropertiesFormat;
+export declare function resourceReferenceArraySerializer(result: Array<ResourceReference>): any[];
+export declare function resourceReferenceArrayDeserializer(result: Array<ResourceReference>): any[];
+/** Resource reference properties. */
+export interface ResourceReference {
+    /** Resource ID. */
+    readonly id?: string;
+}
+export declare function resourceReferenceSerializer(_item: ResourceReference): any;
+export declare function resourceReferenceDeserializer(item: any): ResourceReference;
+/** The current provisioning state. */
+export declare enum KnownProvisioningState {
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Updating */
+    Updating = "Updating",
+    /** Deleting */
+    Deleting = "Deleting",
+    /** Failed */
+    Failed = "Failed"
+}
+/**
+ * The current provisioning state. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded**: Succeeded \
+ * **Updating**: Updating \
+ * **Deleting**: Deleting \
+ * **Failed**: Failed
+ */
+export type ProvisioningState = string;
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {
+}
+export declare function proxyResourceSerializer(_item: ProxyResource): any;
+export declare function proxyResourceDeserializer(item: any): ProxyResource;
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface Resource {
+    /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */
+    readonly id?: string;
+    /** The name of the resource */
+    readonly name?: string;
+    /** The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */
+    readonly type?: string;
+    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
+    readonly systemData?: SystemData;
+}
+export declare function resourceSerializer(_item: Resource): any;
+export declare function resourceDeserializer(item: any): Resource;
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+export declare function systemDataDeserializer(item: any): SystemData;
+/** The kind of entity that created the resource. */
+export declare enum KnownCreatedByType {
+    /** The entity was created by a user. */
+    User = "User",
+    /** The entity was created by an application. */
+    Application = "Application",
+    /** The entity was created by a managed identity. */
+    ManagedIdentity = "ManagedIdentity",
+    /** The entity was created by a key. */
+    Key = "Key"
+}
+/**
+ * The kind of entity that created the resource. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User**: The entity was created by a user. \
+ * **Application**: The entity was created by an application. \
+ * **ManagedIdentity**: The entity was created by a managed identity. \
+ * **Key**: The entity was created by a key.
+ */
+export type CreatedByType = string;
+/** An error response from the service. */
+export interface CloudError {
+    /** An error response from the service. */
+    error?: CloudErrorBody;
+}
+export declare function cloudErrorDeserializer(item: any): CloudError;
+/** An error response from the service. */
+export interface CloudErrorBody {
+    /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
+    code?: string;
+    /** A message describing the error, intended to be suitable for display in a user interface. */
+    message?: string;
+    /** The target of the particular error. For example, the name of the property in error. */
+    target?: string;
+    /** A list of additional details about the error. */
+    details?: CloudErrorBody[];
+}
+export declare function cloudErrorBodyDeserializer(item: any): CloudErrorBody;
+export declare function cloudErrorBodyArrayDeserializer(result: Array<CloudErrorBody>): any[];
+/** Tags object for patch operations. */
+export interface TagsObject {
+    /** Resource tags. */
+    tags?: Record<string, string>;
+}
+export declare function tagsObjectSerializer(item: TagsObject): any;
+/** Collector policy resource. */
+export interface CollectorPolicy extends ProxyResource {
+    /** Resource location. */
+    location: string;
+    /** Resource tags. */
+    tags?: Record<string, string>;
+    /** A unique read-only string that changes whenever the resource is updated. */
+    readonly etag?: string;
+    /** Ingestion policies. */
+    ingestionPolicy?: IngestionPolicyPropertiesFormat;
+    /** Emission policies. */
+    emissionPolicies?: EmissionPoliciesPropertiesFormat[];
+    /** The provisioning state. */
+    readonly provisioningState?: ProvisioningState;
+}
+export declare function collectorPolicySerializer(item: CollectorPolicy): any;
+export declare function collectorPolicyDeserializer(item: any): CollectorPolicy;
+/** Collection policy properties. */
+export interface CollectorPolicyPropertiesFormat {
+    /** Ingestion policies. */
+    ingestionPolicy?: IngestionPolicyPropertiesFormat;
+    /** Emission policies. */
+    emissionPolicies?: EmissionPoliciesPropertiesFormat[];
+    /** The provisioning state. */
+    readonly provisioningState?: ProvisioningState;
+}
+export declare function collectorPolicyPropertiesFormatSerializer(item: CollectorPolicyPropertiesFormat): any;
+export declare function collectorPolicyPropertiesFormatDeserializer(item: any): CollectorPolicyPropertiesFormat;
+/** Ingestion Policy properties. */
+export interface IngestionPolicyPropertiesFormat {
+    /** The ingestion type. */
+    ingestionType?: IngestionType;
+    /** Ingestion Sources. */
+    ingestionSources?: IngestionSourcesPropertiesFormat[];
+}
+export declare function ingestionPolicyPropertiesFormatSerializer(item: IngestionPolicyPropertiesFormat): any;
+export declare function ingestionPolicyPropertiesFormatDeserializer(item: any): IngestionPolicyPropertiesFormat;
+/** The ingestion type. */
+export declare enum KnownIngestionType {
+    /** IPFIX */
+    Ipfix = "IPFIX"
+}
+/**
+ * The ingestion type. \
+ * {@link KnownIngestionType} can be used interchangeably with IngestionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **IPFIX**: IPFIX
+ */
+export type IngestionType = string;
+export declare function ingestionSourcesPropertiesFormatArraySerializer(result: Array<IngestionSourcesPropertiesFormat>): any[];
+export declare function ingestionSourcesPropertiesFormatArrayDeserializer(result: Array<IngestionSourcesPropertiesFormat>): any[];
+/** Ingestion policy properties. */
+export interface IngestionSourcesPropertiesFormat {
+    /** Ingestion source type. */
+    sourceType?: SourceType;
+    /** Resource ID. */
+    resourceId?: string;
+}
+export declare function ingestionSourcesPropertiesFormatSerializer(item: IngestionSourcesPropertiesFormat): any;
+export declare function ingestionSourcesPropertiesFormatDeserializer(item: any): IngestionSourcesPropertiesFormat;
+/** Ingestion source type. */
+export declare enum KnownSourceType {
+    /** Resource */
+    Resource = "Resource"
+}
+/**
+ * Ingestion source type. \
+ * {@link KnownSourceType} can be used interchangeably with SourceType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Resource**: Resource
+ */
+export type SourceType = string;
+export declare function emissionPoliciesPropertiesFormatArraySerializer(result: Array<EmissionPoliciesPropertiesFormat>): any[];
+export declare function emissionPoliciesPropertiesFormatArrayDeserializer(result: Array<EmissionPoliciesPropertiesFormat>): any[];
+/** Emission policy properties. */
+export interface EmissionPoliciesPropertiesFormat {
+    /** Emission format type. */
+    emissionType?: EmissionType;
+    /** Emission policy destinations. */
+    emissionDestinations?: EmissionPolicyDestination[];
+}
+export declare function emissionPoliciesPropertiesFormatSerializer(item: EmissionPoliciesPropertiesFormat): any;
+export declare function emissionPoliciesPropertiesFormatDeserializer(item: any): EmissionPoliciesPropertiesFormat;
+/** Emission format type. */
+export declare enum KnownEmissionType {
+    /** IPFIX */
+    Ipfix = "IPFIX"
+}
+/**
+ * Emission format type. \
+ * {@link KnownEmissionType} can be used interchangeably with EmissionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **IPFIX**: IPFIX
+ */
+export type EmissionType = string;
+export declare function emissionPolicyDestinationArraySerializer(result: Array<EmissionPolicyDestination>): any[];
+export declare function emissionPolicyDestinationArrayDeserializer(result: Array<EmissionPolicyDestination>): any[];
+/** Emission policy destination properties. */
+export interface EmissionPolicyDestination {
+    /** Emission destination type. */
+    destinationType?: DestinationType;
+}
+export declare function emissionPolicyDestinationSerializer(item: EmissionPolicyDestination): any;
+export declare function emissionPolicyDestinationDeserializer(item: any): EmissionPolicyDestination;
+/** Emission destination type. */
+export declare enum KnownDestinationType {
+    /** AzureMonitor */
+    AzureMonitor = "AzureMonitor"
+}
+/**
+ * Emission destination type. \
+ * {@link KnownDestinationType} can be used interchangeably with DestinationType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **AzureMonitor**: AzureMonitor
+ */
+export type DestinationType = string;
+/** The response of a CollectorPolicy list operation. */
+export interface _CollectorPolicyListResult {
+    /** The CollectorPolicy items on this page */
+    value: CollectorPolicy[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _collectorPolicyListResultDeserializer(item: any): _CollectorPolicyListResult;
+export declare function collectorPolicyArraySerializer(result: Array<CollectorPolicy>): any[];
+export declare function collectorPolicyArrayDeserializer(result: Array<CollectorPolicy>): any[];
+/** Paged collection of Operation items */
+export interface _OperationListResult {
+    /** The Operation items on this page */
+    value: Operation[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _operationListResultDeserializer(item: any): _OperationListResult;
+export declare function operationArrayDeserializer(result: Array<Operation>): any[];
+/** Azure Traffic Collector REST API operation definition. */
+export interface Operation {
+    /** Operation name: {provider}/{resource}/{operation} */
+    name?: string;
+    /** Indicates whether the operation is a data action */
+    isDataAction?: boolean;
+    /** Display metadata associated with the operation. */
+    display?: OperationDisplay;
+    /** Origin of the operation */
+    origin?: string;
+}
+export declare function operationDeserializer(item: any): Operation;
+/** Display metadata associated with the operation. */
+export interface OperationDisplay {
+    /** Service provider: Microsoft NetworkFunction. */
+    provider?: string;
+    /** Resource on which the operation is performed etc. */
+    resource?: string;
+    /** Type of operation: get, read, delete, etc. */
+    operation?: string;
+    /** Description of the operation. */
+    description?: string;
+}
+export declare function operationDisplayDeserializer(item: any): OperationDisplay;
+/** The response of a AzureTrafficCollector list operation. */
+export interface _AzureTrafficCollectorListResult {
+    /** The AzureTrafficCollector items on this page */
+    value: AzureTrafficCollector[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _azureTrafficCollectorListResultDeserializer(item: any): _AzureTrafficCollectorListResult;
+export declare function azureTrafficCollectorArraySerializer(result: Array<AzureTrafficCollector>): any[];
+export declare function azureTrafficCollectorArrayDeserializer(result: Array<AzureTrafficCollector>): any[];
+/** The available API versions. */
+export declare enum KnownVersions {
+    /** The 2022-11-01 API version. */
+    V20221101 = "2022-11-01"
+}
+export declare function _azureTrafficCollectorPropertiesSerializer(item: AzureTrafficCollector): any;
+export declare function _azureTrafficCollectorPropertiesDeserializer(item: any): {
+    collectorPolicies: any;
+    virtualHub: any;
+    provisioningState: any;
+};
+export declare function _collectorPolicyPropertiesSerializer(item: CollectorPolicy): any;
+export declare function _collectorPolicyPropertiesDeserializer(item: any): {
+    ingestionPolicy: any;
+    emissionPolicies: any;
+    provisioningState: any;
+};
+//# sourceMappingURL=models.d.ts.map