Class: Azure::ContainerInstance::Mgmt::V2018_10_01::Models::ContainerGroup

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb

Overview

A container group.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#containers ⇒ Array<Container>

Returns The containers within the container group.

Returns:

  • (Array<Container>) —

    The containers within the container group.



24
25
26
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 24

def containers
  @containers
end

#diagnostics ⇒ ContainerGroupDiagnostics

container group.

Returns:



56
57
58
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 56

def diagnostics
  @diagnostics
end

#dns_config ⇒ DnsConfiguration

group.

Returns:



64
65
66
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 64

def dns_config
  @dns_config
end

#identity ⇒ ContainerGroupIdentity

if configured.

Returns:



17
18
19
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 17

def identity
  @identity
end

#image_registry_credentials ⇒ Array<ImageRegistryCredential>

by which the container group is created from.

Returns:



28
29
30
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 28

def image_registry_credentials
  @image_registry_credentials
end

#instance_view ⇒ ContainerGroupPropertiesInstanceView

container group. Only valid in response.

Returns:



52
53
54
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 52

def instance_view
  @instance_view
end

#ip_address ⇒ IpAddress

Returns The IP address type of the container group.

Returns:

  • (IpAddress) —

    The IP address type of the container group.



39
40
41
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 39

def ip_address
  @ip_address
end

#network_profile ⇒ ContainerGroupNetworkProfile

for a container group.

Returns:



60
61
62
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 60

def network_profile
  @network_profile
end

#os_type ⇒ OperatingSystemTypes

the containers in the container group. Possible values include: ‘Windows’, ‘Linux’

Returns:



44
45
46
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 44

def os_type
  @os_type
end

#provisioning_state ⇒ String

only appears in the response.

Returns:

  • (String) —

    The provisioning state of the container group. This



21
22
23
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 21

def provisioning_state
  @provisioning_state
end

#restart_policy ⇒ ContainerGroupRestartPolicy

within the container group.

  • ‘Always` Always restart

  • ‘OnFailure` Restart on failure

  • ‘Never` Never restart

. Possible values include: ‘Always’, ‘OnFailure’, ‘Never’

Returns:



36
37
38
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 36

def restart_policy
  @restart_policy
end

#volumes ⇒ Array<Volume>

containers in this container group.

Returns:

  • (Array<Volume>) —

    The list of volumes that can be mounted by



48
49
50
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 48

def volumes
  @volumes
end

Class Method Details

.mapper ⇒ Object

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



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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/models/container_group.rb', line 71

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ContainerGroup',
    type: {
      name: 'Composite',
      class_name: 'ContainerGroup',
      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'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupIdentity'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        containers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.containers',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ContainerElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Container'
                }
            }
          }
        },
        image_registry_credentials: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.imageRegistryCredentials',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ImageRegistryCredentialElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ImageRegistryCredential'
                }
            }
          }
        },
        restart_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.restartPolicy',
          type: {
            name: 'String'
          }
        },
        ip_address: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipAddress',
          type: {
            name: 'Composite',
            class_name: 'IpAddress'
          }
        },
        os_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osType',
          type: {
            name: 'String'
          }
        },
        volumes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.volumes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VolumeElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Volume'
                }
            }
          }
        },
        instance_view: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.instanceView',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupPropertiesInstanceView'
          }
        },
        diagnostics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnostics',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupDiagnostics'
          }
        },
        network_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkProfile',
          type: {
            name: 'Composite',
            class_name: 'ContainerGroupNetworkProfile'
          }
        },
        dns_config: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsConfig',
          type: {
            name: 'Composite',
            class_name: 'DnsConfiguration'
          }
        }
      }
    }
  }
end