Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::GroupContract

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

Overview

Contract details.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

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



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

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.



19
20
21
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_contract.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_contract.rb', line 16

def display_name
  @display_name
end

#external_id ⇒ String

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) —

    For external groups, this property contains the id of



33
34
35
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_contract.rb', line 33

def external_id
  @external_id
end

#group_contract_type ⇒ GroupType

‘system’, ‘external’

Returns:

  • (GroupType) —

    Group type. Possible values include: ‘custom’,



27
28
29
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_contract.rb', line 27

def group_contract_type
  @group_contract_type
end

Class Method Details

.mapper ⇒ Object

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



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
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
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/group_contract.rb', line 40

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: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        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',
          constraints: {
            MaxLength: 1000
          },
          type: {
            name: 'String'
          }
        },
        built_in: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.builtIn',
          type: {
            name: 'Boolean'
          }
        },
        group_contract_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