pulumi-azure-native-kotlin/com.pulumi.azurenative.storage.kotlin/FileServiceProperties

FileServiceProperties

class FileServiceProperties : KotlinCustomResource

The properties of File services in storage account. Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01. Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storage [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

PutFileServices

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var fileServiceProperties = new AzureNative.Storage.FileServiceProperties("fileServiceProperties", new()
    {
        AccountName = "sto8607",
        Cors = new AzureNative.Storage.Inputs.CorsRulesArgs
        {
            CorsRules = new[]
            {
                new AzureNative.Storage.Inputs.CorsRuleArgs
                {
                    AllowedHeaders = new[]
                    {
                        "x-ms-meta-abc",
                        "x-ms-meta-data*",
                        "x-ms-meta-target*",
                    },
                    AllowedMethods = new[]
                    {
                        AzureNative.Storage.AllowedMethods.GET,
                        AzureNative.Storage.AllowedMethods.HEAD,
                        AzureNative.Storage.AllowedMethods.POST,
                        AzureNative.Storage.AllowedMethods.OPTIONS,
                        AzureNative.Storage.AllowedMethods.MERGE,
                        AzureNative.Storage.AllowedMethods.PUT,
                    },
                    AllowedOrigins = new[]
                    {
                        "http://www.contoso.com",
                        "http://www.fabrikam.com",
                    },
                    ExposedHeaders = new[]
                    {
                        "x-ms-meta-*",
                    },
                    MaxAgeInSeconds = 100,
                },
                new AzureNative.Storage.Inputs.CorsRuleArgs
                {
                    AllowedHeaders = new[]
                    {
                        "*",
                    },
                    AllowedMethods = new[]
                    {
                        AzureNative.Storage.AllowedMethods.GET,
                    },
                    AllowedOrigins = new[]
                    {
                        "*",
                    },
                    ExposedHeaders = new[]
                    {
                        "*",
                    },
                    MaxAgeInSeconds = 2,
                },
                new AzureNative.Storage.Inputs.CorsRuleArgs
                {
                    AllowedHeaders = new[]
                    {
                        "x-ms-meta-12345675754564*",
                    },
                    AllowedMethods = new[]
                    {
                        AzureNative.Storage.AllowedMethods.GET,
                        AzureNative.Storage.AllowedMethods.PUT,
                    },
                    AllowedOrigins = new[]
                    {
                        "http://www.abc23.com",
                        "https://www.fabrikam.com/*",
                    },
                    ExposedHeaders = new[]
                    {
                        "x-ms-meta-abc",
                        "x-ms-meta-data*",
                        "x-ms-meta-target*",
                    },
                    MaxAgeInSeconds = 2000,
                },
            },
        },
        FileServicesName = "default",
        ResourceGroupName = "res4410",
    });
});
Content copied to clipboard
package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewFileServiceProperties(ctx, "fileServiceProperties", &storage.FileServicePropertiesArgs{
			AccountName: pulumi.String("sto8607"),
			Cors: &storage.CorsRulesArgs{
				CorsRules: storage.CorsRuleArray{
					&storage.CorsRuleArgs{
						AllowedHeaders: pulumi.StringArray{
							pulumi.String("x-ms-meta-abc"),
							pulumi.String("x-ms-meta-data*"),
							pulumi.String("x-ms-meta-target*"),
						},
						AllowedMethods: pulumi.StringArray{
							pulumi.String(storage.AllowedMethodsGET),
							pulumi.String(storage.AllowedMethodsHEAD),
							pulumi.String(storage.AllowedMethodsPOST),
							pulumi.String(storage.AllowedMethodsOPTIONS),
							pulumi.String(storage.AllowedMethodsMERGE),
							pulumi.String(storage.AllowedMethodsPUT),
						},
						AllowedOrigins: pulumi.StringArray{
							pulumi.String("http://www.contoso.com"),
							pulumi.String("http://www.fabrikam.com"),
						},
						ExposedHeaders: pulumi.StringArray{
							pulumi.String("x-ms-meta-*"),
						},
						MaxAgeInSeconds: pulumi.Int(100),
					},
					&storage.CorsRuleArgs{
						AllowedHeaders: pulumi.StringArray{
							pulumi.String("*"),
						},
						AllowedMethods: pulumi.StringArray{
							pulumi.String(storage.AllowedMethodsGET),
						},
						AllowedOrigins: pulumi.StringArray{
							pulumi.String("*"),
						},
						ExposedHeaders: pulumi.StringArray{
							pulumi.String("*"),
						},
						MaxAgeInSeconds: pulumi.Int(2),
					},
					&storage.CorsRuleArgs{
						AllowedHeaders: pulumi.StringArray{
							pulumi.String("x-ms-meta-12345675754564*"),
						},
						AllowedMethods: pulumi.StringArray{
							pulumi.String(storage.AllowedMethodsGET),
							pulumi.String(storage.AllowedMethodsPUT),
						},
						AllowedOrigins: pulumi.StringArray{
							pulumi.String("http://www.abc23.com"),
							pulumi.String("https://www.fabrikam.com/*"),
						},
						ExposedHeaders: pulumi.StringArray{
							pulumi.String("x-ms-meta-abc"),
							pulumi.String("x-ms-meta-data*"),
							pulumi.String("x-ms-meta-target*"),
						},
						MaxAgeInSeconds: pulumi.Int(2000),
					},
				},
			},
			FileServicesName:  pulumi.String("default"),
			ResourceGroupName: pulumi.String("res4410"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.FileServiceProperties;
import com.pulumi.azurenative.storage.FileServicePropertiesArgs;
import com.pulumi.azurenative.storage.inputs.CorsRulesArgs;
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 fileServiceProperties = new FileServiceProperties("fileServiceProperties", FileServicePropertiesArgs.builder()
            .accountName("sto8607")
            .cors(CorsRulesArgs.builder()
                .corsRules(
                    CorsRuleArgs.builder()
                        .allowedHeaders(
                            "x-ms-meta-abc",
                            "x-ms-meta-data*",
                            "x-ms-meta-target*")
                        .allowedMethods(
                            "GET",
                            "HEAD",
                            "POST",
                            "OPTIONS",
                            "MERGE",
                            "PUT")
                        .allowedOrigins(
                            "http://www.contoso.com",
                            "http://www.fabrikam.com")
                        .exposedHeaders("x-ms-meta-*")
                        .maxAgeInSeconds(100)
                        .build(),
                    CorsRuleArgs.builder()
                        .allowedHeaders("*")
                        .allowedMethods("GET")
                        .allowedOrigins("*")
                        .exposedHeaders("*")
                        .maxAgeInSeconds(2)
                        .build(),
                    CorsRuleArgs.builder()
                        .allowedHeaders("x-ms-meta-12345675754564*")
                        .allowedMethods(
                            "GET",
                            "PUT")
                        .allowedOrigins(
                            "http://www.abc23.com",
                            "https://www.fabrikam.com/*")
                        .exposedHeaders(
                            "x-ms-meta-abc",
                            "x-ms-meta-data*",
                            "x-ms-meta-target*")
                        .maxAgeInSeconds(2000)
                        .build())
                .build())
            .fileServicesName("default")
            .resourceGroupName("res4410")
            .build());
    }
}
Content copied to clipboard

PutFileServices_EnableSMBMultichannel

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var fileServiceProperties = new AzureNative.Storage.FileServiceProperties("fileServiceProperties", new()
    {
        AccountName = "sto8607",
        FileServicesName = "default",
        ProtocolSettings = new AzureNative.Storage.Inputs.ProtocolSettingsArgs
        {
            Smb = new AzureNative.Storage.Inputs.SmbSettingArgs
            {
                Multichannel = new AzureNative.Storage.Inputs.MultichannelArgs
                {
                    Enabled = true,
                },
            },
        },
        ResourceGroupName = "res4410",
    });
});
Content copied to clipboard
package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewFileServiceProperties(ctx, "fileServiceProperties", &storage.FileServicePropertiesArgs{
			AccountName:      pulumi.String("sto8607"),
			FileServicesName: pulumi.String("default"),
			ProtocolSettings: &storage.ProtocolSettingsArgs{
				Smb: &storage.SmbSettingArgs{
					Multichannel: &storage.MultichannelArgs{
						Enabled: pulumi.Bool(true),
					},
				},
			},
			ResourceGroupName: pulumi.String("res4410"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.FileServiceProperties;
import com.pulumi.azurenative.storage.FileServicePropertiesArgs;
import com.pulumi.azurenative.storage.inputs.ProtocolSettingsArgs;
import com.pulumi.azurenative.storage.inputs.SmbSettingArgs;
import com.pulumi.azurenative.storage.inputs.MultichannelArgs;
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 fileServiceProperties = new FileServiceProperties("fileServiceProperties", FileServicePropertiesArgs.builder()
            .accountName("sto8607")
            .fileServicesName("default")
            .protocolSettings(ProtocolSettingsArgs.builder()
                .smb(SmbSettingArgs.builder()
                    .multichannel(MultichannelArgs.builder()
                        .enabled(true)
                        .build())
                    .build())
                .build())
            .resourceGroupName("res4410")
            .build());
    }
}
Content copied to clipboard

PutFileServices_EnableSecureSmbFeatures

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var fileServiceProperties = new AzureNative.Storage.FileServiceProperties("fileServiceProperties", new()
    {
        AccountName = "sto8607",
        FileServicesName = "default",
        ProtocolSettings = new AzureNative.Storage.Inputs.ProtocolSettingsArgs
        {
            Smb = new AzureNative.Storage.Inputs.SmbSettingArgs
            {
                AuthenticationMethods = "NTLMv2;Kerberos",
                ChannelEncryption = "AES-128-CCM;AES-128-GCM;AES-256-GCM",
                KerberosTicketEncryption = "RC4-HMAC;AES-256",
                Versions = "SMB2.1;SMB3.0;SMB3.1.1",
            },
        },
        ResourceGroupName = "res4410",
    });
});
Content copied to clipboard
package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewFileServiceProperties(ctx, "fileServiceProperties", &storage.FileServicePropertiesArgs{
			AccountName:      pulumi.String("sto8607"),
			FileServicesName: pulumi.String("default"),
			ProtocolSettings: &storage.ProtocolSettingsArgs{
				Smb: &storage.SmbSettingArgs{
					AuthenticationMethods:    pulumi.String("NTLMv2;Kerberos"),
					ChannelEncryption:        pulumi.String("AES-128-CCM;AES-128-GCM;AES-256-GCM"),
					KerberosTicketEncryption: pulumi.String("RC4-HMAC;AES-256"),
					Versions:                 pulumi.String("SMB2.1;SMB3.0;SMB3.1.1"),
				},
			},
			ResourceGroupName: pulumi.String("res4410"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.FileServiceProperties;
import com.pulumi.azurenative.storage.FileServicePropertiesArgs;
import com.pulumi.azurenative.storage.inputs.ProtocolSettingsArgs;
import com.pulumi.azurenative.storage.inputs.SmbSettingArgs;
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 fileServiceProperties = new FileServiceProperties("fileServiceProperties", FileServicePropertiesArgs.builder()
            .accountName("sto8607")
            .fileServicesName("default")
            .protocolSettings(ProtocolSettingsArgs.builder()
                .smb(SmbSettingArgs.builder()
                    .authenticationMethods("NTLMv2;Kerberos")
                    .channelEncryption("AES-128-CCM;AES-128-GCM;AES-256-GCM")
                    .kerberosTicketEncryption("RC4-HMAC;AES-256")
                    .versions("SMB2.1;SMB3.0;SMB3.1.1")
                    .build())
                .build())
            .resourceGroupName("res4410")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:storage:FileServiceProperties default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}
Content copied to clipboard

//*/

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val cors: Output<CorsRulesResponse>?

Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val protocolSettings: Output<ProtocolSettingsResponse>?

Protocol settings for file service

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val shareDeleteRetentionPolicy: Output<DeleteRetentionPolicyResponse>?

The file service properties for share soft delete.

Link copied to clipboard
val sku: Output<SkuResponse>

Sku name and tier.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>