CreateOctKeyOptions.xml

<Type Name="CreateOctKeyOptions" FullName="Azure.Security.KeyVault.Keys.CreateOctKeyOptions">
  <TypeSignature Language="C#" Value="public class CreateOctKeyOptions : Azure.Security.KeyVault.Keys.CreateKeyOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CreateOctKeyOptions extends Azure.Security.KeyVault.Keys.CreateKeyOptions" />
  <TypeSignature Language="DocId" Value="T:Azure.Security.KeyVault.Keys.CreateOctKeyOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class CreateOctKeyOptions&#xA;Inherits CreateKeyOptions" />
  <TypeSignature Language="F#" Value="type CreateOctKeyOptions = class&#xA;    inherit CreateKeyOptions" />
  <AssemblyInfo>
    <AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
    <AssemblyVersion>4.2.0.0</AssemblyVersion>
    <AssemblyVersion>4.3.0.0</AssemblyVersion>
    <AssemblyVersion>4.4.0.0</AssemblyVersion>
    <AssemblyVersion>4.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.6.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.Security.KeyVault.Keys.CreateKeyOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            The properties needed to create an AES key using the <see cref="T:Azure.Security.KeyVault.Keys.KeyClient" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CreateOctKeyOptions (string name, bool hardwareProtected = false);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, bool hardwareProtected) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Security.KeyVault.Keys.CreateOctKeyOptions.#ctor(System.String,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional hardwareProtected As Boolean = false)" />
      <MemberSignature Language="F#" Value="new Azure.Security.KeyVault.Keys.CreateOctKeyOptions : string * bool -&gt; Azure.Security.KeyVault.Keys.CreateOctKeyOptions" Usage="new Azure.Security.KeyVault.Keys.CreateOctKeyOptions (name, hardwareProtected)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
        <AssemblyVersion>4.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="hardwareProtected" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="name">The name of the key to create.</param>
        <param name="hardwareProtected">True to create a hardware-protected key in a hardware security module (HSM). The default is false to create a software key.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.Security.KeyVault.Keys.CreateOctKeyOptions" /> class.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentException">
          <paramref name="name" /> is empty.</exception>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="name" /> is null.</exception>
      </Docs>
    </Member>
    <Member MemberName="HardwareProtected">
      <MemberSignature Language="C#" Value="public bool HardwareProtected { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool HardwareProtected" />
      <MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.CreateOctKeyOptions.HardwareProtected" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property HardwareProtected As Boolean" />
      <MemberSignature Language="F#" Value="member this.HardwareProtected : bool" Usage="Azure.Security.KeyVault.Keys.CreateOctKeyOptions.HardwareProtected" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
        <AssemblyVersion>4.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets a value indicating whether to create a hardware-protected key in a hardware security module (HSM).
            </summary>
        <value>
          <c>true</c> to create a hardware-protected key; otherwise, <c>false</c> to create a software key.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="KeySize">
      <MemberSignature Language="C#" Value="public int? KeySize { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; KeySize" />
      <MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.CreateOctKeyOptions.KeySize" />
      <MemberSignature Language="VB.NET" Value="Public Property KeySize As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.KeySize : Nullable&lt;int&gt; with get, set" Usage="Azure.Security.KeyVault.Keys.CreateOctKeyOptions.KeySize" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
        <AssemblyVersion>4.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the key size in bits, such as 128, 192, or 256. If null, the service default is used.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="KeyType">
      <MemberSignature Language="C#" Value="public Azure.Security.KeyVault.Keys.KeyType KeyType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Security.KeyVault.Keys.KeyType KeyType" />
      <MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.CreateOctKeyOptions.KeyType" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property KeyType As KeyType" />
      <MemberSignature Language="F#" Value="member this.KeyType : Azure.Security.KeyVault.Keys.KeyType" Usage="Azure.Security.KeyVault.Keys.CreateOctKeyOptions.KeyType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
        <AssemblyVersion>4.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Security.KeyVault.Keys.KeyType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the key type of the <see cref="T:Azure.Security.KeyVault.Keys.JsonWebKey" /> to create, including <see cref="P:Azure.Security.KeyVault.Keys.KeyType.Oct" /> and <see cref="P:Azure.Security.KeyVault.Keys.KeyType.OctHsm" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.CreateOctKeyOptions.Name" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
      <MemberSignature Language="F#" Value="member this.Name : string" Usage="Azure.Security.KeyVault.Keys.CreateOctKeyOptions.Name" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
        <AssemblyVersion>4.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the name of the key to create.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>