@pulumi/azure-native/databoxedge/share.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * Represents a share on the  Data Box Edge/Gateway device.
 *
 * Uses Azure REST API version 2023-07-01. In version 2.x of the Azure Native provider, it used API version 2022-03-01.
 *
 * Other available API versions: 2022-03-01, 2022-04-01-preview, 2022-12-01-preview, 2023-01-01-preview, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native databoxedge [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare class Share extends pulumi.CustomResource {
    /**
     * Get an existing Share resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Share;
    /**
     * Returns true if the given object is an instance of Share.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Share;
    /**
     * Access protocol to be used by the share.
     */
    readonly accessProtocol: pulumi.Output<string>;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: pulumi.Output<string>;
    /**
     * Azure container mapping for the share.
     */
    readonly azureContainerInfo: pulumi.Output<outputs.databoxedge.AzureContainerInfoResponse | undefined>;
    /**
     * List of IP addresses and corresponding access rights on the share(required for NFS protocol).
     */
    readonly clientAccessRights: pulumi.Output<outputs.databoxedge.ClientAccessRightResponse[] | undefined>;
    /**
     * Data policy of the share.
     */
    readonly dataPolicy: pulumi.Output<string | undefined>;
    /**
     * Description for the share.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Current monitoring status of the share.
     */
    readonly monitoringStatus: pulumi.Output<string>;
    /**
     * The object name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Details of the refresh job on this share.
     */
    readonly refreshDetails: pulumi.Output<outputs.databoxedge.RefreshDetailsResponse | undefined>;
    /**
     * Share mount point to the role.
     */
    readonly shareMappings: pulumi.Output<outputs.databoxedge.MountPointMapResponse[]>;
    /**
     * Current status of the share.
     */
    readonly shareStatus: pulumi.Output<string>;
    /**
     * Metadata pertaining to creation and last modification of Share
     */
    readonly systemData: pulumi.Output<outputs.databoxedge.SystemDataResponse>;
    /**
     * The hierarchical type of the object.
     */
    readonly type: pulumi.Output<string>;
    /**
     * Mapping of users and corresponding access rights on the share (required for SMB protocol).
     */
    readonly userAccessRights: pulumi.Output<outputs.databoxedge.UserAccessRightResponse[] | undefined>;
    /**
     * Create a Share resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ShareArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a Share resource.
 */
export interface ShareArgs {
    /**
     * Access protocol to be used by the share.
     */
    accessProtocol: pulumi.Input<string | enums.databoxedge.ShareAccessProtocol>;
    /**
     * Azure container mapping for the share.
     */
    azureContainerInfo?: pulumi.Input<inputs.databoxedge.AzureContainerInfoArgs>;
    /**
     * List of IP addresses and corresponding access rights on the share(required for NFS protocol).
     */
    clientAccessRights?: pulumi.Input<pulumi.Input<inputs.databoxedge.ClientAccessRightArgs>[]>;
    /**
     * Data policy of the share.
     */
    dataPolicy?: pulumi.Input<string | enums.databoxedge.DataPolicy>;
    /**
     * Description for the share.
     */
    description?: pulumi.Input<string>;
    /**
     * The device name.
     */
    deviceName: pulumi.Input<string>;
    /**
     * Current monitoring status of the share.
     */
    monitoringStatus: pulumi.Input<string | enums.databoxedge.MonitoringStatus>;
    /**
     * The share name.
     */
    name?: pulumi.Input<string>;
    /**
     * Details of the refresh job on this share.
     */
    refreshDetails?: pulumi.Input<inputs.databoxedge.RefreshDetailsArgs>;
    /**
     * The resource group name.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * Current status of the share.
     */
    shareStatus: pulumi.Input<string | enums.databoxedge.ShareStatus>;
    /**
     * Mapping of users and corresponding access rights on the share (required for SMB protocol).
     */
    userAccessRights?: pulumi.Input<pulumi.Input<inputs.databoxedge.UserAccessRightArgs>[]>;
}