Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::ApiManagementServiceBaseProperties

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

Overview

Base Properties of an API Management service resource description.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#additional_locations ⇒ Array<AdditionalLocation>

the API Management service.

Returns:



65
66
67
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 65

def additional_locations
  @additional_locations
end

#certificates ⇒ Array<CertificateConfiguration>

need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Returns:



81
82
83
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 81

def certificates
  @certificates
end

#created_at_utc ⇒ DateTime

date conforms to the following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Returns:

  • (DateTime) —

    Creation UTC date of the API Management service.The



31
32
33
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 31

def created_at_utc
  @created_at_utc
end

#custom_properties ⇒ Hash{String => String}

Management service. Setting ‘Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.

Returns:

  • (Hash{String => String}) —

    Custom properties of the API



76
77
78
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 76

def custom_properties
  @custom_properties
end

#gateway_regional_url ⇒ String

Default Region.

Returns:

  • (String) —

    Gateway URL of the API Management service in the



38
39
40
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 38

def gateway_regional_url
  @gateway_regional_url
end

#gateway_url ⇒ String

Returns Gateway URL of the API Management service.

Returns:

  • (String) —

    Gateway URL of the API Management service.



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

def gateway_url
  @gateway_url
end

#hostname_configurations ⇒ Array<HostnameConfiguration>

the API Management service.

Returns:



53
54
55
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 53

def hostname_configurations
  @hostname_configurations
end

#management_api_url ⇒ String

service.

Returns:

  • (String) —

    Management API endpoint URL of the API Management



46
47
48
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 46

def management_api_url
  @management_api_url
end

#notification_sender_email ⇒ String

sent.

Returns:

  • (String) —

    Email address from which the notification will be



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

def notification_sender_email
  @notification_sender_email
end

#portal_url ⇒ String

service.

Returns:

  • (String) —

    Publisher portal endpoint Url of the API Management



42
43
44
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 42

def portal_url
  @portal_url
end

#provisioning_state ⇒ String

service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

Returns:

  • (String) —

    The current provisioning state of the API Management



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

def provisioning_state
  @provisioning_state
end

#scm_url ⇒ String

Returns SCM endpoint URL of the API Management service.

Returns:

  • (String) —

    SCM endpoint URL of the API Management service.



49
50
51
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 49

def scm_url
  @scm_url
end

#static_ips ⇒ Array<String>

service virtual machines. Available only for Standard and Premium SKU.

Returns:

  • (Array<String>) —

    Static IP addresses of the API Management



57
58
59
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 57

def static_ips
  @static_ips
end

#target_provisioning_state ⇒ String

which is targeted by the long running operation started on the service.

Returns:

  • (String) —

    The provisioning state of the API Management service,



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

def target_provisioning_state
  @target_provisioning_state
end

#virtual_network_configuration ⇒ VirtualNetworkConfiguration

the API Management service.

Returns:



61
62
63
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 61

def virtual_network_configuration
  @virtual_network_configuration
end

#virtual_network_type ⇒ VirtualNetworkType

service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: ‘None’, ‘External’, ‘Internal’. Default value: ‘None’ .

Returns:



91
92
93
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 91

def virtual_network_type
  @virtual_network_type
end

Class Method Details

.mapper ⇒ Object

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



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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_base_properties.rb', line 98

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApiManagementServiceBaseProperties',
    type: {
      name: 'Composite',
      class_name: 'ApiManagementServiceBaseProperties',
      model_properties: {
        notification_sender_email: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationSenderEmail',
          constraints: {
            MaxLength: 100
          },
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'provisioningState',
          type: {
            name: 'String'
          }
        },
        target_provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'targetProvisioningState',
          type: {
            name: 'String'
          }
        },
        created_at_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'createdAtUtc',
          type: {
            name: 'DateTime'
          }
        },
        gateway_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'gatewayUrl',
          type: {
            name: 'String'
          }
        },
        gateway_regional_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'gatewayRegionalUrl',
          type: {
            name: 'String'
          }
        },
        portal_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'portalUrl',
          type: {
            name: 'String'
          }
        },
        management_api_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'managementApiUrl',
          type: {
            name: 'String'
          }
        },
        scm_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'scmUrl',
          type: {
            name: 'String'
          }
        },
        hostname_configurations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'hostnameConfigurations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'HostnameConfigurationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'HostnameConfiguration'
                }
            }
          }
        },
        static_ips: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'staticIps',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        virtual_network_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'virtualNetworkConfiguration',
          type: {
            name: 'Composite',
            class_name: 'VirtualNetworkConfiguration'
          }
        },
        additional_locations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'additionalLocations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AdditionalLocationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AdditionalLocation'
                }
            }
          }
        },
        custom_properties: {
          client_side_validation: true,
          required: false,
          serialized_name: 'customProperties',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        certificates: {
          client_side_validation: true,
          required: false,
          serialized_name: 'certificates',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CertificateConfigurationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'CertificateConfiguration'
                }
            }
          }
        },
        virtual_network_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'virtualNetworkType',
          default_value: 'None',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end