Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::HostnameConfiguration

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

Overview

Custom hostname configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#certificate ⇒ CertificateInformation

Returns Certificate information.

Returns:



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

def certificate
  @certificate
end

#certificate_password ⇒ String

Returns Certificate Password.

Returns:

  • (String) —

    Certificate Password.



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

def certificate_password
  @certificate_password
end

#default_ssl_binding ⇒ Boolean

this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type. Default value: false .

Returns:

  • (Boolean) —

    Specify true to setup the certificate associated with



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

def default_ssl_binding
  @default_ssl_binding
end

#encoded_certificate ⇒ String

Returns Base64 Encoded certificate.

Returns:

  • (String) —

    Base64 Encoded certificate.



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

def encoded_certificate
  @encoded_certificate
end

#host_name ⇒ String

Returns Hostname to configure on the Api Management service.

Returns:

  • (String) —

    Hostname to configure on the Api Management service.



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

def host_name
  @host_name
end

#key_vault_id ⇒ String

Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type application/x-pkcs12

Returns:

  • (String) —

    Url to the KeyVault Secret containing the Ssl



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

def key_vault_id
  @key_vault_id
end

#negotiate_client_certificate ⇒ Boolean

on the hostname. Default Value is false. Default value: false .

Returns:

  • (Boolean) —

    Specify true to always negotiate client certificate



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

def negotiate_client_certificate
  @negotiate_client_certificate
end

#type ⇒ HostnameType

‘Portal’, ‘Management’, ‘Scm’

Returns:

  • (HostnameType) —

    Hostname type. Possible values include: ‘Proxy’,



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

def type
  @type
end

Class Method Details

.mapper ⇒ Object

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



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
129
130
131
132
133
134
135
136
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/hostname_configuration.rb', line 55

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'HostnameConfiguration',
    type: {
      name: 'Composite',
      class_name: 'HostnameConfiguration',
      model_properties: {
        type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'type',
          type: {
            name: 'Enum',
            module: 'HostnameType'
          }
        },
        host_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'hostName',
          type: {
            name: 'String'
          }
        },
        key_vault_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'keyVaultId',
          type: {
            name: 'String'
          }
        },
        encoded_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'encodedCertificate',
          type: {
            name: 'String'
          }
        },
        certificate_password: {
          client_side_validation: true,
          required: false,
          serialized_name: 'certificatePassword',
          type: {
            name: 'String'
          }
        },
        default_ssl_binding: {
          client_side_validation: true,
          required: false,
          serialized_name: 'defaultSslBinding',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        negotiate_client_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'negotiateClientCertificate',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        certificate: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'certificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateInformation'
          }
        }
      }
    }
  }
end