SqlRoleDefinitionCreateUpdateParameters.xml

<Type Name="SqlRoleDefinitionCreateUpdateParameters" FullName="Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters">
  <TypeSignature Language="C#" Value="public class SqlRoleDefinitionCreateUpdateParameters" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SqlRoleDefinitionCreateUpdateParameters extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters" />
  <TypeSignature Language="VB.NET" Value="Public Class SqlRoleDefinitionCreateUpdateParameters" />
  <TypeSignature Language="F#" Value="type SqlRoleDefinitionCreateUpdateParameters = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
    <AssemblyVersion>3.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Microsoft.Rest.Serialization.JsonTransformation]</AttributeName>
      <AttributeName Language="F#">[&lt;Microsoft.Rest.Serialization.JsonTransformation&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Parameters to create and update an Azure Cosmos DB SQL Role Definition.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SqlRoleDefinitionCreateUpdateParameters ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
        <AssemblyVersion>3.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the
            SqlRoleDefinitionCreateUpdateParameters class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SqlRoleDefinitionCreateUpdateParameters (string roleName = default, Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType? type = default, System.Collections.Generic.IList&lt;string&gt; assignableScopes = default, System.Collections.Generic.IList&lt;Microsoft.Azure.Management.CosmosDB.Models.Permission&gt; permissions = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string roleName, valuetype System.Nullable`1&lt;valuetype Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType&gt; type, class System.Collections.Generic.IList`1&lt;string&gt; assignableScopes, class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.Management.CosmosDB.Models.Permission&gt; permissions) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.#ctor(System.String,System.Nullable{Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{Microsoft.Azure.Management.CosmosDB.Models.Permission})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional roleName As String = Nothing, Optional type As Nullable(Of RoleDefinitionType) = Nothing, Optional assignableScopes As IList(Of String) = Nothing, Optional permissions As IList(Of Permission) = Nothing)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters : string * Nullable&lt;Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType&gt; * System.Collections.Generic.IList&lt;string&gt; * System.Collections.Generic.IList&lt;Microsoft.Azure.Management.CosmosDB.Models.Permission&gt; -&gt; Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters" Usage="new Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters (roleName, type, assignableScopes, permissions)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
        <AssemblyVersion>3.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="roleName" Type="System.String" />
        <Parameter Name="type" Type="System.Nullable&lt;Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType&gt;" />
        <Parameter Name="assignableScopes" Type="System.Collections.Generic.IList&lt;System.String&gt;" />
        <Parameter Name="permissions" Type="System.Collections.Generic.IList&lt;Microsoft.Azure.Management.CosmosDB.Models.Permission&gt;" />
      </Parameters>
      <Docs>
        <param name="roleName">A user-friendly name for the Role
            Definition. Must be unique for the database account.</param>
        <param name="type">Indicates whether the Role Definition was
            built-in or user created. Possible values include: 'BuiltInRole',
            'CustomRole'</param>
        <param name="assignableScopes">A set of fully qualified Scopes at
            or below which Role Assignments may be created using this Role
            Definition. This will allow application of this Role Definition on
            the entire database account or any underlying Database /
            Collection. Must have at least one element. Scopes higher than
            Database account are not enforceable as assignable Scopes. Note
            that resources referenced in assignable Scopes need not
            exist.</param>
        <param name="permissions">The set of operations allowed through
            this Role Definition.</param>
        <summary>
            Initializes a new instance of the
            SqlRoleDefinitionCreateUpdateParameters class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AssignableScopes">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; AssignableScopes { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; AssignableScopes" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.AssignableScopes" />
      <MemberSignature Language="VB.NET" Value="Public Property AssignableScopes As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.AssignableScopes : System.Collections.Generic.IList&lt;string&gt; with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.AssignableScopes" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
        <AssemblyVersion>3.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.assignableScopes")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="properties.assignableScopes")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a set of fully qualified Scopes at or below which Role
            Assignments may be created using this Role Definition. This will
            allow application of this Role Definition on the entire database
            account or any underlying Database / Collection. Must have at least
            one element. Scopes higher than Database account are not
            enforceable as assignable Scopes. Note that resources referenced in
            assignable Scopes need not exist.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Permissions">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Microsoft.Azure.Management.CosmosDB.Models.Permission&gt; Permissions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.Management.CosmosDB.Models.Permission&gt; Permissions" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.Permissions" />
      <MemberSignature Language="VB.NET" Value="Public Property Permissions As IList(Of Permission)" />
      <MemberSignature Language="F#" Value="member this.Permissions : System.Collections.Generic.IList&lt;Microsoft.Azure.Management.CosmosDB.Models.Permission&gt; with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.Permissions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
        <AssemblyVersion>3.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.permissions")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="properties.permissions")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Microsoft.Azure.Management.CosmosDB.Models.Permission&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the set of operations allowed through this Role
            Definition.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RoleName">
      <MemberSignature Language="C#" Value="public string RoleName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string RoleName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.RoleName" />
      <MemberSignature Language="VB.NET" Value="Public Property RoleName As String" />
      <MemberSignature Language="F#" Value="member this.RoleName : string with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.RoleName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
        <AssemblyVersion>3.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.roleName")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="properties.roleName")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a user-friendly name for the Role Definition. Must be
            unique for the database account.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Type">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType? Type { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType&gt; Type" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.Type" />
      <MemberSignature Language="VB.NET" Value="Public Property Type As Nullable(Of RoleDefinitionType)" />
      <MemberSignature Language="F#" Value="member this.Type : Nullable&lt;Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType&gt; with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.SqlRoleDefinitionCreateUpdateParameters.Type" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
        <AssemblyVersion>3.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.type")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="properties.type")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Microsoft.Azure.Management.CosmosDB.Models.RoleDefinitionType&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets indicates whether the Role Definition was built-in or
            user created. Possible values include: 'BuiltInRole', 'CustomRole'
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>