ClientAuthenticationWithSharedAccessKeyRefresh.xml

<Type Name="ClientAuthenticationWithSharedAccessKeyRefresh" FullName="Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh">
  <TypeSignature Language="C#" Value="public class ClientAuthenticationWithSharedAccessKeyRefresh : Microsoft.Azure.Devices.Client.ClientAuthenticationWithTokenRefresh" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientAuthenticationWithSharedAccessKeyRefresh extends Microsoft.Azure.Devices.Client.ClientAuthenticationWithTokenRefresh" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh" />
  <TypeSignature Language="VB.NET" Value="Public Class ClientAuthenticationWithSharedAccessKeyRefresh&#xA;Inherits ClientAuthenticationWithTokenRefresh" />
  <TypeSignature Language="F#" Value="type ClientAuthenticationWithSharedAccessKeyRefresh = class&#xA;    inherit ClientAuthenticationWithTokenRefresh" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Azure.Devices.Client.ClientAuthenticationWithTokenRefresh</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Authentication method that generates shared access signature (SAS) token with refresh, based on a provided shared access key (SAK).
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientAuthenticationWithSharedAccessKeyRefresh (string connectionString, TimeSpan sasTokenTimeToLive = default, int sasTokenRenewalBuffer = 0);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString, valuetype System.TimeSpan sasTokenTimeToLive, int32 sasTokenRenewalBuffer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.#ctor(System.String,System.TimeSpan,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String, Optional sasTokenTimeToLive As TimeSpan = Nothing, Optional sasTokenRenewalBuffer As Integer = 0)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh : string * TimeSpan * int -&gt; Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh" Usage="new Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh (connectionString, sasTokenTimeToLive, sasTokenRenewalBuffer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="connectionString" Type="System.String" />
        <Parameter Name="sasTokenTimeToLive" Type="System.TimeSpan" />
        <Parameter Name="sasTokenRenewalBuffer" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="connectionString">
            The connection string containing the device Id, optional module Id, shared access key name
            and shared access key to be used for authenticating with IoT hub service.
            </param>
        <param name="sasTokenTimeToLive">
            The suggested time to live value for the generated SAS tokens.
            The default value is 1 hour.
            </param>
        <param name="sasTokenRenewalBuffer">
            The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live.
            The default behavior is that the token will be renewed when it has 15% or less of its lifespan left.
            </param>
        <summary>
            Creates an instance of this class.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="connectionString" /> is null.</exception>
        <exception cref="T:System.ArgumentException">Thrown when <paramref name="connectionString" /> is empty or whitespace.</exception>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientAuthenticationWithSharedAccessKeyRefresh (string sharedAccessKey, string deviceId, string moduleId = default, TimeSpan sasTokenTimeToLive = default, int sasTokenRenewalBuffer = 0);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string sharedAccessKey, string deviceId, string moduleId, valuetype System.TimeSpan sasTokenTimeToLive, int32 sasTokenRenewalBuffer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.#ctor(System.String,System.String,System.String,System.TimeSpan,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (sharedAccessKey As String, deviceId As String, Optional moduleId As String = Nothing, Optional sasTokenTimeToLive As TimeSpan = Nothing, Optional sasTokenRenewalBuffer As Integer = 0)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh : string * string * string * TimeSpan * int -&gt; Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh" Usage="new Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh (sharedAccessKey, deviceId, moduleId, sasTokenTimeToLive, sasTokenRenewalBuffer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="sharedAccessKey" Type="System.String" />
        <Parameter Name="deviceId" Type="System.String" />
        <Parameter Name="moduleId" Type="System.String" />
        <Parameter Name="sasTokenTimeToLive" Type="System.TimeSpan" />
        <Parameter Name="sasTokenRenewalBuffer" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="sharedAccessKey">Shared access key value.</param>
        <param name="deviceId">Device identifier.</param>
        <param name="moduleId">Module identifier.</param>
        <param name="sasTokenTimeToLive">
            The suggested time to live value for the generated SAS tokens.
            The default value is 1 hour.
            </param>
        <param name="sasTokenRenewalBuffer">
            The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live.
            The default behavior is that the token will be renewed when it has 15% or less of its lifespan left.
            </param>
        <summary>
            Creates an instance of this class.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="sharedAccessKey" /> is null.</exception>
        <exception cref="T:System.ArgumentException">
            Thrown when <paramref name="sharedAccessKey" /> is empty or whitespace.
            </exception>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientAuthenticationWithSharedAccessKeyRefresh (string sharedAccessKey, string sharedAccessKeyName, string deviceId, string moduleId = default, TimeSpan sasTokenTimeToLive = default, int sasTokenRenewalBuffer = 0);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string sharedAccessKey, string sharedAccessKeyName, string deviceId, string moduleId, valuetype System.TimeSpan sasTokenTimeToLive, int32 sasTokenRenewalBuffer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.#ctor(System.String,System.String,System.String,System.String,System.TimeSpan,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (sharedAccessKey As String, sharedAccessKeyName As String, deviceId As String, Optional moduleId As String = Nothing, Optional sasTokenTimeToLive As TimeSpan = Nothing, Optional sasTokenRenewalBuffer As Integer = 0)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh : string * string * string * string * TimeSpan * int -&gt; Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh" Usage="new Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh (sharedAccessKey, sharedAccessKeyName, deviceId, moduleId, sasTokenTimeToLive, sasTokenRenewalBuffer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="sharedAccessKey" Type="System.String" />
        <Parameter Name="sharedAccessKeyName" Type="System.String" />
        <Parameter Name="deviceId" Type="System.String" />
        <Parameter Name="moduleId" Type="System.String" />
        <Parameter Name="sasTokenTimeToLive" Type="System.TimeSpan" />
        <Parameter Name="sasTokenRenewalBuffer" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="sharedAccessKey">Shared access key value.</param>
        <param name="sharedAccessKeyName">Shared access key name.</param>
        <param name="deviceId">Device identifier.</param>
        <param name="moduleId">Module identifier.</param>
        <param name="sasTokenTimeToLive">
            The suggested time to live value for the generated SAS tokens.
            The default value is 1 hour.
            </param>
        <param name="sasTokenRenewalBuffer">
            The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live.
            The default behavior is that the token will be renewed when it has 15% or less of its lifespan left.
            </param>
        <summary>
            Creates an instance of this class.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
            Thrown when <paramref name="sharedAccessKey" /> or <paramref name="sharedAccessKeyName" /> is null.
            </exception>
        <exception cref="T:System.ArgumentException">
            Thrown when <paramref name="sharedAccessKey" /> or <paramref name="sharedAccessKeyName" /> is empty or whitespace.
            </exception>
      </Docs>
    </Member>
    <Member MemberName="Populate">
      <MemberSignature Language="C#" Value="public override void Populate (ref Microsoft.Azure.Devices.Client.IotHubConnectionCredentials iotHubConnectionCredentials);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Populate(class Microsoft.Azure.Devices.Client.IotHubConnectionCredentials&amp; iotHubConnectionCredentials) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.Populate(Microsoft.Azure.Devices.Client.IotHubConnectionCredentials@)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Sub Populate (ByRef iotHubConnectionCredentials As IotHubConnectionCredentials)" />
      <MemberSignature Language="F#" Value="override this.Populate : IotHubConnectionCredentials -&gt; unit" Usage="clientAuthenticationWithSharedAccessKeyRefresh.Populate iotHubConnectionCredentials" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="iotHubConnectionCredentials" Type="Microsoft.Azure.Devices.Client.IotHubConnectionCredentials" RefType="ref" />
      </Parameters>
      <Docs>
        <param name="iotHubConnectionCredentials">Instance to populate.</param>
        <summary>
            Populates an <see cref="T:Microsoft.Azure.Devices.Client.IotHubConnectionCredentials" /> instance based on a snapshot of the properties of
            the current instance.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="iotHubConnectionCredentials" /> is null.</exception>
      </Docs>
    </Member>
    <Member MemberName="SafeCreateNewTokenAsync">
      <MemberSignature Language="C#" Value="protected override System.Threading.Tasks.Task&lt;string&gt; SafeCreateNewTokenAsync (string iotHub, TimeSpan suggestedTimeToLive);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Threading.Tasks.Task`1&lt;string&gt; SafeCreateNewTokenAsync(string iotHub, valuetype System.TimeSpan suggestedTimeToLive) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.SafeCreateNewTokenAsync(System.String,System.TimeSpan)" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Function SafeCreateNewTokenAsync (iotHub As String, suggestedTimeToLive As TimeSpan) As Task(Of String)" />
      <MemberSignature Language="F#" Value="override this.SafeCreateNewTokenAsync : string * TimeSpan -&gt; System.Threading.Tasks.Task&lt;string&gt;" Usage="clientAuthenticationWithSharedAccessKeyRefresh.SafeCreateNewTokenAsync (iotHub, suggestedTimeToLive)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="iotHub" Type="System.String" />
        <Parameter Name="suggestedTimeToLive" Type="System.TimeSpan" />
      </Parameters>
      <Docs>
        <param name="iotHub">To be added.</param>
        <param name="suggestedTimeToLive">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="SharedAccessKey">
      <MemberSignature Language="C#" Value="public string SharedAccessKey { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SharedAccessKey" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.SharedAccessKey" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SharedAccessKey As String" />
      <MemberSignature Language="F#" Value="member this.SharedAccessKey : string" Usage="Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.SharedAccessKey" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the shared access key.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SharedAccessKeyName">
      <MemberSignature Language="C#" Value="public string SharedAccessKeyName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SharedAccessKeyName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.SharedAccessKeyName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SharedAccessKeyName As String" />
      <MemberSignature Language="F#" Value="member this.SharedAccessKeyName : string" Usage="Microsoft.Azure.Devices.Client.ClientAuthenticationWithSharedAccessKeyRefresh.SharedAccessKeyName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the shared access key name.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>