AzureFilesIdentityBasedAuthentication Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Settings for Azure Files identity based authentication.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.AzureFilesIdentityBasedAuthenticationTypeConverter))]
public class AzureFilesIdentityBasedAuthentication : Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IAzureFilesIdentityBasedAuthentication
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.AzureFilesIdentityBasedAuthenticationTypeConverter))>]
type AzureFilesIdentityBasedAuthentication = class
interface IAzureFilesIdentityBasedAuthentication
interface IJsonSerializable
Public Class AzureFilesIdentityBasedAuthentication
Implements IAzureFilesIdentityBasedAuthentication
- Inheritance
-
AzureFilesIdentityBasedAuthentication
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| AzureFilesIdentityBasedAuthentication() |
Creates an new AzureFilesIdentityBasedAuthentication instance. |
Properties
| Name | Description |
|---|---|
| ActiveDirectoryPropertyAccountType |
Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. |
| ActiveDirectoryPropertyAzureStorageSid |
Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| ActiveDirectoryPropertyDomainGuid |
Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. |
| ActiveDirectoryPropertyDomainName |
Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. |
| ActiveDirectoryPropertyDomainSid |
Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| ActiveDirectoryPropertyForestName |
Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| ActiveDirectoryPropertyNetBiosDomainName |
Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| ActiveDirectoryPropertySamAccountName |
Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. |
| DefaultSharePermission |
Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
| DirectoryServiceOption |
Indicates the directory service used. Note that this enum may be extended in the future. |
| SmbOAuthSettingIsSmbOauthEnabled |
Specifies if managed identities can access SMB shares using OAuth. The default interpretation is false for this property. |
Methods
| Name | Description |
|---|---|
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of AzureFilesIdentityBasedAuthentication. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of AzureFilesIdentityBasedAuthentication. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IAzureFilesIdentityBasedAuthentication. |
| FromJsonString(String) |
Creates a new instance of AzureFilesIdentityBasedAuthentication, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of AzureFilesIdentityBasedAuthentication into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |
| ToString() | |