com.pulumi.azurenative.databoxedge.Share Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.databoxedge;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.databoxedge.ShareArgs;
import com.pulumi.azurenative.databoxedge.outputs.AzureContainerInfoResponse;
import com.pulumi.azurenative.databoxedge.outputs.ClientAccessRightResponse;
import com.pulumi.azurenative.databoxedge.outputs.MountPointMapResponse;
import com.pulumi.azurenative.databoxedge.outputs.RefreshDetailsResponse;
import com.pulumi.azurenative.databoxedge.outputs.SystemDataResponse;
import com.pulumi.azurenative.databoxedge.outputs.UserAccessRightResponse;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Represents a share on the Data Box Edge/Gateway device.
* Azure REST API version: 2022-03-01. Prior API version in Azure Native 1.x: 2020-12-01.
*
* Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.
*
* ## Example Usage
* ### SharePut
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.databoxedge.Share;
* import com.pulumi.azurenative.databoxedge.ShareArgs;
* import com.pulumi.azurenative.databoxedge.inputs.AzureContainerInfoArgs;
* import com.pulumi.azurenative.databoxedge.inputs.UserAccessRightArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var share = new Share("share", ShareArgs.builder()
* .accessProtocol("SMB")
* .azureContainerInfo(AzureContainerInfoArgs.builder()
* .containerName("testContainerSMB")
* .dataFormat("BlockBlob")
* .storageAccountCredentialId("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1")
* .build())
* .dataPolicy("Cloud")
* .description("")
* .deviceName("testedgedevice")
* .monitoringStatus("Enabled")
* .name("smbshare")
* .resourceGroupName("GroupForEdgeAutomation")
* .shareStatus("Online")
* .userAccessRights(UserAccessRightArgs.builder()
* .accessType("Change")
* .userId("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2")
* .build())
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:databoxedge:Share smbshare /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
* ```
*
*/
@ResourceType(type="azure-native:databoxedge:Share")
public class Share extends com.pulumi.resources.CustomResource {
/**
* Access protocol to be used by the share.
*
*/
@Export(name="accessProtocol", refs={String.class}, tree="[0]")
private Output accessProtocol;
/**
* @return Access protocol to be used by the share.
*
*/
public Output accessProtocol() {
return this.accessProtocol;
}
/**
* Azure container mapping for the share.
*
*/
@Export(name="azureContainerInfo", refs={AzureContainerInfoResponse.class}, tree="[0]")
private Output azureContainerInfo;
/**
* @return Azure container mapping for the share.
*
*/
public Output> azureContainerInfo() {
return Codegen.optional(this.azureContainerInfo);
}
/**
* List of IP addresses and corresponding access rights on the share(required for NFS protocol).
*
*/
@Export(name="clientAccessRights", refs={List.class,ClientAccessRightResponse.class}, tree="[0,1]")
private Output> clientAccessRights;
/**
* @return List of IP addresses and corresponding access rights on the share(required for NFS protocol).
*
*/
public Output>> clientAccessRights() {
return Codegen.optional(this.clientAccessRights);
}
/**
* Data policy of the share.
*
*/
@Export(name="dataPolicy", refs={String.class}, tree="[0]")
private Output dataPolicy;
/**
* @return Data policy of the share.
*
*/
public Output> dataPolicy() {
return Codegen.optional(this.dataPolicy);
}
/**
* Description for the share.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return Description for the share.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Current monitoring status of the share.
*
*/
@Export(name="monitoringStatus", refs={String.class}, tree="[0]")
private Output monitoringStatus;
/**
* @return Current monitoring status of the share.
*
*/
public Output monitoringStatus() {
return this.monitoringStatus;
}
/**
* The object name.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The object name.
*
*/
public Output name() {
return this.name;
}
/**
* Details of the refresh job on this share.
*
*/
@Export(name="refreshDetails", refs={RefreshDetailsResponse.class}, tree="[0]")
private Output refreshDetails;
/**
* @return Details of the refresh job on this share.
*
*/
public Output> refreshDetails() {
return Codegen.optional(this.refreshDetails);
}
/**
* Share mount point to the role.
*
*/
@Export(name="shareMappings", refs={List.class,MountPointMapResponse.class}, tree="[0,1]")
private Output> shareMappings;
/**
* @return Share mount point to the role.
*
*/
public Output> shareMappings() {
return this.shareMappings;
}
/**
* Current status of the share.
*
*/
@Export(name="shareStatus", refs={String.class}, tree="[0]")
private Output shareStatus;
/**
* @return Current status of the share.
*
*/
public Output shareStatus() {
return this.shareStatus;
}
/**
* Metadata pertaining to creation and last modification of Share
*
*/
@Export(name="systemData", refs={SystemDataResponse.class}, tree="[0]")
private Output systemData;
/**
* @return Metadata pertaining to creation and last modification of Share
*
*/
public Output systemData() {
return this.systemData;
}
/**
* The hierarchical type of the object.
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The hierarchical type of the object.
*
*/
public Output type() {
return this.type;
}
/**
* Mapping of users and corresponding access rights on the share (required for SMB protocol).
*
*/
@Export(name="userAccessRights", refs={List.class,UserAccessRightResponse.class}, tree="[0,1]")
private Output> userAccessRights;
/**
* @return Mapping of users and corresponding access rights on the share (required for SMB protocol).
*
*/
public Output>> userAccessRights() {
return Codegen.optional(this.userAccessRights);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Share(java.lang.String name) {
this(name, ShareArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Share(java.lang.String name, ShareArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Share(java.lang.String name, ShareArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:databoxedge:Share", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Share(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:databoxedge:Share", name, null, makeResourceOptions(options, id), false);
}
private static ShareArgs makeArgs(ShareArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ShareArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:databoxedge/v20190301:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20190701:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20190801:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20200501preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20200901:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20200901preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20201201:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20210201:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20210201preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20210601:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20210601preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20220301:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20220401preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20221201preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20230101preview:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20230701:Share").build()),
Output.of(Alias.builder().type("azure-native:databoxedge/v20231201:Share").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host 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 options Optional settings to control the behavior of the CustomResource.
*/
public static Share get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Share(name, id, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy