Partager via


StorageAccountCreateParameters Class

Definition

The parameters used when creating a storage account.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.StorageAccountCreateParametersTypeConverter))]
public class StorageAccountCreateParameters : Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageAccountCreateParameters
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.StorageAccountCreateParametersTypeConverter))>]
type StorageAccountCreateParameters = class
    interface IStorageAccountCreateParameters
    interface IJsonSerializable
Public Class StorageAccountCreateParameters
Implements IStorageAccountCreateParameters
Inheritance
StorageAccountCreateParameters
Attributes
Implements

Constructors

StorageAccountCreateParameters()

Creates an new StorageAccountCreateParameters instance.

Properties

AccessTier

Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type.

ActiveDirectoryPropertyAccountType

Specifies the Active Directory account type for Azure Storage.

ActiveDirectoryPropertyAzureStorageSid

Specifies the security identifier (SID) for Azure Storage.

ActiveDirectoryPropertyDomainGuid

Specifies the domain GUID.

ActiveDirectoryPropertyDomainName

Specifies the primary domain that the AD DNS server is authoritative for.

ActiveDirectoryPropertyDomainSid

Specifies the security identifier (SID).

ActiveDirectoryPropertyForestName

Specifies the Active Directory forest to get.

ActiveDirectoryPropertyNetBiosDomainName

Specifies the NetBIOS domain name.

ActiveDirectoryPropertySamAccountName

Specifies the Active Directory SAMAccountName for Azure Storage.

AllowBlobPublicAccess

Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

AllowCrossTenantReplication

Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

AllowedCopyScope

Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.

AllowSharedKeyAccess

Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

AzureFileIdentityBasedAuthenticationDefaultSharePermission

Default share permission for users using Kerberos authentication if RBAC role is not assigned.

AzureFileIdentityBasedAuthenticationDirectoryServiceOption

Indicates the directory service used. Note that this enum may be extended in the future.

CustomDomainName

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

CustomDomainUseSubDomainName

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

DefaultToOAuthAuthentication

A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

DnsEndpointType

Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier.

EnableHttpsTrafficOnly

Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.

EnableNfsV3

NFS 3.0 protocol support enabled if set to true.

Encryption

Encryption settings to be used for server-side encryption for the storage account.

ExtendedLocationName

The name of the extended location.

ExtendedLocationType

The type of the extended location.

IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The identity type.

IdentityUserAssignedIdentity

Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.

ImmutabilityPolicyAllowProtectedAppendWrite

This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

ImmutabilityPolicyImmutabilityPeriodSinceCreationInDay

The immutability period for the blobs in the container since the policy creation, in days.

ImmutabilityPolicyState

The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted.

ImmutableStorageWithVersioningEnabled

A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default.

IsHnsEnabled

Account HierarchicalNamespace enabled if sets to true.

IsLocalUserEnabled

Enables local users feature, if set to true

IsSftpEnabled

Enables Secure File Transfer Protocol, if set to true

KeyPolicyKeyExpirationPeriodInDay

The key expiration period in days.

Kind

Required. Indicates the type of storage account.

LargeFileSharesState

Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.

Location

Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.

MinimumTlsVersion

Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.

NetworkRuleSetBypass

Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.

NetworkRuleSetDefaultAction

Specifies the default action of allow or deny when no other rules match.

NetworkRuleSetIPRule

Sets the IP ACL rules

NetworkRuleSetResourceAccessRule

Sets the resource access rules

NetworkRuleSetVirtualNetworkRule

Sets the virtual network rules

PublicNetworkAccess

Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

RoutingPreferencePublishInternetEndpoint

A boolean flag which indicates whether internet routing storage endpoints are to be published

RoutingPreferencePublishMicrosoftEndpoint

A boolean flag which indicates whether microsoft routing storage endpoints are to be published

RoutingPreferenceRoutingChoice

Routing Choice defines the kind of network routing opted by the user.

SasPolicyExpirationAction

The SAS expiration action. Can only be Log.

SasPolicySasExpirationPeriod

The SAS expiration period, DD.HH:MM:SS.

SkuName

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

SkuTier

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

Tag

Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of StorageAccountCreateParameters.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of StorageAccountCreateParameters.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageAccountCreateParameters.

FromJsonString(String)

Creates a new instance of StorageAccountCreateParameters, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of StorageAccountCreateParameters into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to