Class: Azure::ApiManagement::Mgmt::V2016_07_07::Models::GroupContract

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb

Overview

Developer group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#built_in ⇒ Boolean

(Administrators, Developers, or Guests); otherwise false.

Returns:

  • (Boolean) —

    true if the group is one of the three system groups



28
29
30
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 28

def built_in
  @built_in
end

#description ⇒ String

Returns Group description. Can contain HTML formatting tags.

Returns:

  • (String) —

    Group description. Can contain HTML formatting tags.



24
25
26
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 24

def description
  @description
end

#external_id ⇒ String

the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null.

Returns:

  • (String) —

    For external groups, this property contains the id of



37
38
39
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 37

def external_id
  @external_id
end

#id ⇒ String

Management service instance. The value is a valid relative URL in the format of /groups/groupId where groupId is a group identifier.

Returns:

  • (String) —

    Uniquely identifies the group within the current API



18
19
20
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 18

def id
  @id
end

#name ⇒ String

Returns Group name.

Returns:

  • (String) —

    Group name.



21
22
23
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 21

def name
  @name
end

#type ⇒ GroupTypeContract

‘Custom’, ‘System’, ‘External’

Returns:



32
33
34
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 32

def type
  @type
end

Class Method Details

.mapper ⇒ Object

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



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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/group_contract.rb', line 44

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'GroupContract',
    type: {
      name: 'Composite',
      class_name: 'GroupContract',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'name',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          constraints: {
            MaxLength: 1000
          },
          type: {
            name: 'String'
          }
        },
        built_in: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'builtIn',
          type: {
            name: 'Boolean'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'Enum',
            module: 'GroupTypeContract'
          }
        },
        external_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'externalId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end