EnvironmentCredentialOptions.xml

<Type Name="EnvironmentCredentialOptions" FullName="Azure.Identity.EnvironmentCredentialOptions">
  <TypeSignature Language="C#" Value="public class EnvironmentCredentialOptions : Azure.Identity.TokenCredentialOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EnvironmentCredentialOptions extends Azure.Identity.TokenCredentialOptions" />
  <TypeSignature Language="DocId" Value="T:Azure.Identity.EnvironmentCredentialOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class EnvironmentCredentialOptions&#xA;Inherits TokenCredentialOptions" />
  <TypeSignature Language="F#" Value="type EnvironmentCredentialOptions = class&#xA;    inherit TokenCredentialOptions" />
  <AssemblyInfo>
    <AssemblyName>Azure.Identity</AssemblyName>
    <AssemblyVersion>1.9.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.Identity.TokenCredentialOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options used to configure the <see cref="T:Azure.Identity.EnvironmentCredential" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public EnvironmentCredentialOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Identity.EnvironmentCredentialOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AdditionallyAllowedTenants">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; AdditionallyAllowedTenants { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; AdditionallyAllowedTenants" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.AdditionallyAllowedTenants" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property AdditionallyAllowedTenants As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.AdditionallyAllowedTenants : System.Collections.Generic.IList&lt;string&gt;" Usage="Azure.Identity.EnvironmentCredentialOptions.AdditionallyAllowedTenants" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Specifies tenants in addition to the specified <see cref="P:Azure.Identity.EnvironmentCredentialOptions.TenantId" /> for which the credential may acquire tokens.
            Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the logged in account can access.
            If no value is specified for <see cref="P:Azure.Identity.EnvironmentCredentialOptions.TenantId" />, this option will have no effect on that authentication method, and the credential will acquire tokens for any requested tenant when using that method.
            This value defaults to the value of the environment variable AZURE_ADDITIONALLY_ALLOWED_TENANTS.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClientCertificatePassword">
      <MemberSignature Language="C#" Value="public string ClientCertificatePassword { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ClientCertificatePassword" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.ClientCertificatePassword" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientCertificatePassword As String" />
      <MemberSignature Language="F#" Value="member this.ClientCertificatePassword : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.ClientCertificatePassword" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The password of the client certificate used to authenticate the service pricipal. This value defaults to the value of the environment variable AZURE_CLIENT_CERTIFICATE_PASSWORD.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClientCertificatePath">
      <MemberSignature Language="C#" Value="public string ClientCertificatePath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ClientCertificatePath" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.ClientCertificatePath" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientCertificatePath As String" />
      <MemberSignature Language="F#" Value="member this.ClientCertificatePath : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.ClientCertificatePath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The path to the client certificate used to authenticate the service pricipal. This value defaults to the value of the environment variable AZURE_CLIENT_CERTIFICATE_PATH.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClientId">
      <MemberSignature Language="C#" Value="public string ClientId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ClientId" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.ClientId" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientId As String" />
      <MemberSignature Language="F#" Value="member this.ClientId : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.ClientId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The client ID (app ID) of the service pricipal the credential will authenticate. This value defaults to the value of the environment variable AZURE_CLIENT_ID.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClientSecret">
      <MemberSignature Language="C#" Value="public string ClientSecret { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ClientSecret" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.ClientSecret" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientSecret As String" />
      <MemberSignature Language="F#" Value="member this.ClientSecret : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.ClientSecret" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The client secret used to authenticate the service pricipal. This value defaults to the value of the environment variable AZURE_CLIENT_SECRET.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DisableInstanceDiscovery">
      <MemberSignature Language="C#" Value="public bool DisableInstanceDiscovery { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool DisableInstanceDiscovery" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.DisableInstanceDiscovery" />
      <MemberSignature Language="VB.NET" Value="Public Property DisableInstanceDiscovery As Boolean" />
      <MemberSignature Language="F#" Value="member this.DisableInstanceDiscovery : bool with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.DisableInstanceDiscovery" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Determines whether or not instance discovery is performed when attempting to authenticate.
            Setting this to true will completely disable instance discovery and authority validation.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Password">
      <MemberSignature Language="C#" Value="public string Password { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Password" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.Password" />
      <MemberSignature Language="VB.NET" Value="Public Property Password As String" />
      <MemberSignature Language="F#" Value="member this.Password : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.Password" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The password of used to authenticate the user. This value defaults to the value of the environment variable AZURE_PASSWORD.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SendCertificateChain">
      <MemberSignature Language="C#" Value="public bool SendCertificateChain { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool SendCertificateChain" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.SendCertificateChain" />
      <MemberSignature Language="VB.NET" Value="Public Property SendCertificateChain As Boolean" />
      <MemberSignature Language="F#" Value="member this.SendCertificateChain : bool with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.SendCertificateChain" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Will include x5c header in client claims when acquiring a token to enable certificate subject name / issuer based authentication. This value defaults to the value of the environment variable AZURE_CLIENT_SEND_CERTIFICATE_CHAIN.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TenantId">
      <MemberSignature Language="C#" Value="public string TenantId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TenantId" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.TenantId" />
      <MemberSignature Language="VB.NET" Value="Public Property TenantId As String" />
      <MemberSignature Language="F#" Value="member this.TenantId : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.TenantId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The ID of the tenant to which the credential will authenticate by default. This value defaults to the value of the environment variable AZURE_TENANT_ID.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Username">
      <MemberSignature Language="C#" Value="public string Username { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Username" />
      <MemberSignature Language="DocId" Value="P:Azure.Identity.EnvironmentCredentialOptions.Username" />
      <MemberSignature Language="VB.NET" Value="Public Property Username As String" />
      <MemberSignature Language="F#" Value="member this.Username : string with get, set" Usage="Azure.Identity.EnvironmentCredentialOptions.Username" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Identity</AssemblyName>
        <AssemblyVersion>1.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The username of the user account the credeential will authenticate. This value defaults to the value of the environment variable AZURE_USERNAME.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>