Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::GroupCreateParameters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/models/group_create_parameters.rb

Overview

Parameters supplied to the Create Group operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#description ⇒ String

Returns Group description.

Returns:

  • (String) —

    Group description.



19
20
21
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_create_parameters.rb', line 19

def description
  @description
end

#display_name ⇒ String

Returns Group name.

Returns:

  • (String) —

    Group name.



16
17
18
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_create_parameters.rb', line 16

def display_name
  @display_name
end

#external_id ⇒ String

contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Returns:

  • (String) —

    Identifier of the external groups, this property



29
30
31
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_create_parameters.rb', line 29

def external_id
  @external_id
end

#type ⇒ GroupType

‘system’, ‘external’

Returns:

  • (GroupType) —

    Group type. Possible values include: ‘custom’,



23
24
25
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_create_parameters.rb', line 23

def type
  @type
end

Class Method Details

.mapper ⇒ Object

Mapper for GroupCreateParameters class as Ruby Hash. This will be used for serialization/deserialization.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_create_parameters.rb', line 36

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'GroupCreateParameters',
    type: {
      name: 'Composite',
      class_name: 'GroupCreateParameters',
      model_properties: {
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.displayName',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.type',
          type: {
            name: 'Enum',
            module: 'GroupType'
          }
        },
        external_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.externalId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end