Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getFileServiceProperties

The properties of File services in storage account. API Version: 2021-02-01.

Using getFileServiceProperties

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFileServiceProperties(args: GetFileServicePropertiesArgs, opts?: InvokeOptions): Promise<GetFileServicePropertiesResult>
function getFileServicePropertiesOutput(args: GetFileServicePropertiesOutputArgs, opts?: InvokeOptions): Output<GetFileServicePropertiesResult>
def get_file_service_properties(account_name: Optional[str] = None,
                                file_services_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetFileServicePropertiesResult
def get_file_service_properties_output(account_name: Optional[pulumi.Input[str]] = None,
                                file_services_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetFileServicePropertiesResult]
func LookupFileServiceProperties(ctx *Context, args *LookupFileServicePropertiesArgs, opts ...InvokeOption) (*LookupFileServicePropertiesResult, error)
func LookupFileServicePropertiesOutput(ctx *Context, args *LookupFileServicePropertiesOutputArgs, opts ...InvokeOption) LookupFileServicePropertiesResultOutput

> Note: This function is named LookupFileServiceProperties in the Go SDK.

public static class GetFileServiceProperties 
{
    public static Task<GetFileServicePropertiesResult> InvokeAsync(GetFileServicePropertiesArgs args, InvokeOptions? opts = null)
    public static Output<GetFileServicePropertiesResult> Invoke(GetFileServicePropertiesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFileServicePropertiesResult> getFileServiceProperties(GetFileServicePropertiesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:storage:getFileServiceProperties
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

FileServicesName string

The name of the file Service within the specified storage account. File Service Name must be "default"

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

AccountName string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

FileServicesName string

The name of the file Service within the specified storage account. File Service Name must be "default"

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

accountName String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

fileServicesName String

The name of the file Service within the specified storage account. File Service Name must be "default"

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

accountName string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

fileServicesName string

The name of the file Service within the specified storage account. File Service Name must be "default"

resourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

account_name str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

file_services_name str

The name of the file Service within the specified storage account. File Service Name must be "default"

resource_group_name str

The name of the resource group within the user's subscription. The name is case insensitive.

accountName String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

fileServicesName String

The name of the file Service within the specified storage account. File Service Name must be "default"

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

getFileServiceProperties Result

The following output properties are available:

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

Sku Pulumi.AzureNative.Storage.Outputs.SkuResponse

Sku name and tier.

Type string

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

Cors Pulumi.AzureNative.Storage.Outputs.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.

ProtocolSettings Pulumi.AzureNative.Storage.Outputs.ProtocolSettingsResponse

Protocol settings for file service

ShareDeleteRetentionPolicy Pulumi.AzureNative.Storage.Outputs.DeleteRetentionPolicyResponse

The file service properties for share soft delete.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

Sku SkuResponse

Sku name and tier.

Type string

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

Cors 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.

ProtocolSettings ProtocolSettingsResponse

Protocol settings for file service

ShareDeleteRetentionPolicy DeleteRetentionPolicyResponse

The file service properties for share soft delete.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

sku SkuResponse

Sku name and tier.

type String

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

cors 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.

protocolSettings ProtocolSettingsResponse

Protocol settings for file service

shareDeleteRetentionPolicy DeleteRetentionPolicyResponse

The file service properties for share soft delete.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name string

The name of the resource

sku SkuResponse

Sku name and tier.

type string

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

cors 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.

protocolSettings ProtocolSettingsResponse

Protocol settings for file service

shareDeleteRetentionPolicy DeleteRetentionPolicyResponse

The file service properties for share soft delete.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name str

The name of the resource

sku SkuResponse

Sku name and tier.

type str

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

cors 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.

protocol_settings ProtocolSettingsResponse

Protocol settings for file service

share_delete_retention_policy DeleteRetentionPolicyResponse

The file service properties for share soft delete.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

sku Property Map

Sku name and tier.

type String

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

cors Property Map

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.

protocolSettings Property Map

Protocol settings for file service

shareDeleteRetentionPolicy Property Map

The file service properties for share soft delete.

Supporting Types

CorsRuleResponse

AllowedHeaders List<string>

Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.

AllowedMethods List<string>

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

AllowedOrigins List<string>

Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains

ExposedHeaders List<string>

Required if CorsRule element is present. A list of response headers to expose to CORS clients.

MaxAgeInSeconds int

Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

AllowedHeaders []string

Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.

AllowedMethods []string

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

AllowedOrigins []string

Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains

ExposedHeaders []string

Required if CorsRule element is present. A list of response headers to expose to CORS clients.

MaxAgeInSeconds int

Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

allowedHeaders List

Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.

allowedMethods List

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

allowedOrigins List

Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains

exposedHeaders List

Required if CorsRule element is present. A list of response headers to expose to CORS clients.

maxAgeInSeconds Integer

Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

allowedHeaders string[]

Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.

allowedMethods string[]

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

allowedOrigins string[]

Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains

exposedHeaders string[]

Required if CorsRule element is present. A list of response headers to expose to CORS clients.

maxAgeInSeconds number

Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

allowed_headers Sequence[str]

Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.

allowed_methods Sequence[str]

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

allowed_origins Sequence[str]

Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains

exposed_headers Sequence[str]

Required if CorsRule element is present. A list of response headers to expose to CORS clients.

max_age_in_seconds int

Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

allowedHeaders List

Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.

allowedMethods List

Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.

allowedOrigins List

Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains

exposedHeaders List

Required if CorsRule element is present. A list of response headers to expose to CORS clients.

maxAgeInSeconds Number

Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.

CorsRulesResponse

CorsRules List<Pulumi.AzureNative.Storage.Inputs.CorsRuleResponse>

The List of CORS rules. You can include up to five CorsRule elements in the request.

CorsRules []CorsRuleResponse

The List of CORS rules. You can include up to five CorsRule elements in the request.

corsRules ListRuleResponse>

The List of CORS rules. You can include up to five CorsRule elements in the request.

corsRules CorsRuleResponse[]

The List of CORS rules. You can include up to five CorsRule elements in the request.

cors_rules Sequence[CorsRuleResponse]

The List of CORS rules. You can include up to five CorsRule elements in the request.

corsRules List

The List of CORS rules. You can include up to five CorsRule elements in the request.

DeleteRetentionPolicyResponse

Days int

Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

Enabled bool

Indicates whether DeleteRetentionPolicy is enabled.

Days int

Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

Enabled bool

Indicates whether DeleteRetentionPolicy is enabled.

days Integer

Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

enabled Boolean

Indicates whether DeleteRetentionPolicy is enabled.

days number

Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

enabled boolean

Indicates whether DeleteRetentionPolicy is enabled.

days int

Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

enabled bool

Indicates whether DeleteRetentionPolicy is enabled.

days Number

Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

enabled Boolean

Indicates whether DeleteRetentionPolicy is enabled.

MultichannelResponse

Enabled bool

Indicates whether multichannel is enabled

Enabled bool

Indicates whether multichannel is enabled

enabled Boolean

Indicates whether multichannel is enabled

enabled boolean

Indicates whether multichannel is enabled

enabled bool

Indicates whether multichannel is enabled

enabled Boolean

Indicates whether multichannel is enabled

ProtocolSettingsResponse

Smb SmbSettingResponse

Setting for SMB protocol

smb SmbSettingResponse

Setting for SMB protocol

smb SmbSettingResponse

Setting for SMB protocol

smb SmbSettingResponse

Setting for SMB protocol

smb Property Map

Setting for SMB protocol

SkuResponse

Name string

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

Tier string

The SKU tier. This is based on the SKU name.

Name string

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

Tier string

The SKU tier. This is based on the SKU name.

name String

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

tier String

The SKU tier. This is based on the SKU name.

name string

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

tier string

The SKU tier. This is based on the SKU name.

name str

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

tier str

The SKU tier. This is based on the SKU name.

name String

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

tier String

The SKU tier. This is based on the SKU name.

SmbSettingResponse

AuthenticationMethods string

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

ChannelEncryption string

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

KerberosTicketEncryption string

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'

Multichannel Pulumi.AzureNative.Storage.Inputs.MultichannelResponse

Multichannel setting. Applies to Premium FileStorage only.

Versions string

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

AuthenticationMethods string

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

ChannelEncryption string

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

KerberosTicketEncryption string

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'

Multichannel MultichannelResponse

Multichannel setting. Applies to Premium FileStorage only.

Versions string

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

authenticationMethods String

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

channelEncryption String

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

kerberosTicketEncryption String

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'

multichannel MultichannelResponse

Multichannel setting. Applies to Premium FileStorage only.

versions String

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

authenticationMethods string

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

channelEncryption string

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

kerberosTicketEncryption string

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'

multichannel MultichannelResponse

Multichannel setting. Applies to Premium FileStorage only.

versions string

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

authentication_methods str

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

channel_encryption str

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

kerberos_ticket_encryption str

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'

multichannel MultichannelResponse

Multichannel setting. Applies to Premium FileStorage only.

versions str

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

authenticationMethods String

SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'.

channelEncryption String

SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'.

kerberosTicketEncryption String

Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';'

multichannel Property Map

Multichannel setting. Applies to Premium FileStorage only.

versions String

SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0