Dependencies/Assemblies/Microsoft365DSC.Connection.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft365DSC.Connection</name>
    </assembly>
    <members>
        <member name="T:Microsoft365DSC.Connection.ConnectionHelper">
            <summary>
            Provides methods for determining the most secure authentication type
            supported by Microsoft365DSC resources.
            </summary>
        </member>
        <member name="M:Microsoft365DSC.Connection.ConnectionHelper.GetComponentsWithMostSecureAuthenticationType(System.Collections.IDictionary,System.String[],System.String[])">
            <summary>
            Determines the most secure authentication method supported by each requested resource from a
            map of resource name (with or without the MSFT_ prefix) to the names of its DSC properties.
            </summary>
            <param name="propertyNamesByResource">The property names declared by each resource.</param>
            <param name="authenticationMethods">
            The authentication methods to evaluate, in order of preference:
            ApplicationWithSecret, CertificateThumbprint, CertificatePath, Credentials,
            CredentialsWithTenantId, CredentialsWithApplicationId, ManagedIdentity, AccessTokens.
            </param>
            <param name="resources">The resource names to evaluate (without MSFT_ prefix).</param>
            <returns>A list of Hashtable objects, each containing 'Resource' (string) and 'AuthMethod' (string).</returns>
        </member>
        <member name="M:Microsoft365DSC.Connection.ConnectionHelper.ToPropertyNames(System.Object)">
            <summary>Collects the property names of a map value, accepting any non-string enumerable.</summary>
        </member>
        <member name="T:Microsoft365DSC.Connection.ConnectionHelper.AuthenticationCandidate">
            <summary>
            One authentication method a resource may support, and what it takes to qualify.
            </summary>
        </member>
        <member name="P:Microsoft365DSC.Connection.ConnectionHelper.AuthenticationCandidate.Method">
            <summary>The method name as supplied by the caller.</summary>
        </member>
        <member name="P:Microsoft365DSC.Connection.ConnectionHelper.AuthenticationCandidate.AuthMethod">
            <summary>The name reported back for this method.</summary>
        </member>
        <member name="P:Microsoft365DSC.Connection.ConnectionHelper.AuthenticationCandidate.RequiredProperties">
            <summary>Properties the resource must declare for this method to apply.</summary>
        </member>
        <member name="P:Microsoft365DSC.Connection.ConnectionHelper.AuthenticationCandidate.ExcludedResourcePrefixes">
            <summary>Resource name prefixes this method never applies to.</summary>
        </member>
        <member name="F:Microsoft365DSC.Connection.ConnectionHelper.AuthenticationPriority">
            <summary>
            The authentication methods in descending order of security. The first candidate whose
            method was requested and whose properties the resource declares wins.
            </summary>
        </member>
        <member name="M:Microsoft365DSC.Connection.ConnectionHelper.DetermineMostSecureAuthMethod(System.Collections.Generic.HashSet{System.String},System.Collections.Generic.HashSet{System.String},System.String)">
            <summary>
            Determines the most secure authentication method for a resource based on
            the authentication methods requested and the DSC properties the resource declares.
            </summary>
        </member>
    </members>
</doc>