WcfRelayData.xml

<Type Name="WcfRelayData" FullName="Azure.ResourceManager.Relay.WcfRelayData">
  <TypeSignature Language="C#" Value="public class WcfRelayData : Azure.ResourceManager.Models.ResourceData" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WcfRelayData extends Azure.ResourceManager.Models.ResourceData" />
  <TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Relay.WcfRelayData" />
  <TypeSignature Language="VB.NET" Value="Public Class WcfRelayData&#xA;Inherits ResourceData" />
  <TypeSignature Language="F#" Value="type WcfRelayData = class&#xA;    inherit ResourceData" />
  <AssemblyInfo>
    <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.1.0</AssemblyVersion>
    <AssemblyVersion>1.2.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.ResourceManager.Models.ResourceData</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            A class representing the WcfRelay data model.
            Description of the WCF relay resource.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public WcfRelayData ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Relay.WcfRelayData.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary> Initializes a new instance of <see cref="T:Azure.ResourceManager.Relay.WcfRelayData" />. </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreatedOn">
      <MemberSignature Language="C#" Value="public DateTimeOffset? CreatedOn { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.DateTimeOffset&gt; CreatedOn" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.CreatedOn" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property CreatedOn As Nullable(Of DateTimeOffset)" />
      <MemberSignature Language="F#" Value="member this.CreatedOn : Nullable&lt;DateTimeOffset&gt;" Usage="Azure.ResourceManager.Relay.WcfRelayData.CreatedOn" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.DateTimeOffset&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The time the WCF relay was created. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsClientAuthorizationRequired">
      <MemberSignature Language="C#" Value="public bool? IsClientAuthorizationRequired { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; IsClientAuthorizationRequired" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.IsClientAuthorizationRequired" />
      <MemberSignature Language="VB.NET" Value="Public Property IsClientAuthorizationRequired As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.IsClientAuthorizationRequired : Nullable&lt;bool&gt; with get, set" Usage="Azure.ResourceManager.Relay.WcfRelayData.IsClientAuthorizationRequired" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Returns true if client authorization is needed for this relay; otherwise, false. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsDynamic">
      <MemberSignature Language="C#" Value="public bool? IsDynamic { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; IsDynamic" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.IsDynamic" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsDynamic As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.IsDynamic : Nullable&lt;bool&gt;" Usage="Azure.ResourceManager.Relay.WcfRelayData.IsDynamic" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Returns true if the relay is dynamic; otherwise, false. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsTransportSecurityRequired">
      <MemberSignature Language="C#" Value="public bool? IsTransportSecurityRequired { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; IsTransportSecurityRequired" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.IsTransportSecurityRequired" />
      <MemberSignature Language="VB.NET" Value="Public Property IsTransportSecurityRequired As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.IsTransportSecurityRequired : Nullable&lt;bool&gt; with get, set" Usage="Azure.ResourceManager.Relay.WcfRelayData.IsTransportSecurityRequired" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Returns true if transport security is needed for this relay; otherwise, false. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ListenerCount">
      <MemberSignature Language="C#" Value="public int? ListenerCount { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; ListenerCount" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.ListenerCount" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ListenerCount As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.ListenerCount : Nullable&lt;int&gt;" Usage="Azure.ResourceManager.Relay.WcfRelayData.ListenerCount" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The number of listeners for this relay. Note that min :1 and max:25 are supported. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Location">
      <MemberSignature Language="C#" Value="public Azure.Core.AzureLocation? Location { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Azure.Core.AzureLocation&gt; Location" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.Location" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Location As Nullable(Of AzureLocation)" />
      <MemberSignature Language="F#" Value="member this.Location : Nullable&lt;Azure.Core.AzureLocation&gt;" Usage="Azure.ResourceManager.Relay.WcfRelayData.Location" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Azure.Core.AzureLocation&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The geo-location where the resource lives. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RelayType">
      <MemberSignature Language="C#" Value="public Azure.ResourceManager.Relay.Models.RelayType? RelayType { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Azure.ResourceManager.Relay.Models.RelayType&gt; RelayType" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.RelayType" />
      <MemberSignature Language="VB.NET" Value="Public Property RelayType As Nullable(Of RelayType)" />
      <MemberSignature Language="F#" Value="member this.RelayType : Nullable&lt;Azure.ResourceManager.Relay.Models.RelayType&gt; with get, set" Usage="Azure.ResourceManager.Relay.WcfRelayData.RelayType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Azure.ResourceManager.Relay.Models.RelayType&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> WCF relay type. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UpdatedOn">
      <MemberSignature Language="C#" Value="public DateTimeOffset? UpdatedOn { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.DateTimeOffset&gt; UpdatedOn" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.UpdatedOn" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property UpdatedOn As Nullable(Of DateTimeOffset)" />
      <MemberSignature Language="F#" Value="member this.UpdatedOn : Nullable&lt;DateTimeOffset&gt;" Usage="Azure.ResourceManager.Relay.WcfRelayData.UpdatedOn" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.DateTimeOffset&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The time the namespace was updated. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UserMetadata">
      <MemberSignature Language="C#" Value="public string UserMetadata { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string UserMetadata" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Relay.WcfRelayData.UserMetadata" />
      <MemberSignature Language="VB.NET" Value="Public Property UserMetadata As String" />
      <MemberSignature Language="F#" Value="member this.UserMetadata : string with get, set" Usage="Azure.ResourceManager.Relay.WcfRelayData.UserMetadata" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Relay</AssemblyName>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>