Class: Azure::ARM::Web::Models::HostName

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/host_name.rb

Overview

Details of a hostname derived from a domain.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#azure_resource_name ⇒ String

to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.

Returns:

  • (String) —

    Name of the Azure resource the hostname is assigned



27
28
29
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 27

def azure_resource_name
  @azure_resource_name
end

#azure_resource_type ⇒ AzureResourceType

assigned to. Possible values include: ‘Website’, ‘TrafficManager’

Returns:



31
32
33
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 31

def azure_resource_type
  @azure_resource_type
end

#custom_host_name_dns_record_type ⇒ CustomHostNameDnsRecordType

values include: ‘CName’, ‘A’

Returns:



35
36
37
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 35

def custom_host_name_dns_record_type
  @custom_host_name_dns_record_type
end

#host_name_type ⇒ HostNameType

‘Verified’, ‘Managed’

Returns:

  • (HostNameType) —

    Type of the hostname. Possible values include:



39
40
41
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 39

def host_name_type
  @host_name_type
end

#name ⇒ String

Returns Name of the hostname.

Returns:

  • (String) —

    Name of the hostname.



17
18
19
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 17

def name
  @name
end

#site_names ⇒ Array<String>

list will have more than one app only if the hostname is pointing to a Traffic Manager.

Returns:

  • (Array<String>) —

    List of apps the hostname is assigned to. This



22
23
24
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 22

def site_names
  @site_names
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/generated/azure_mgmt_web/models/host_name.rb', line 46

def self.mapper()
  {
    required: false,
    serialized_name: 'HostName',
    type: {
      name: 'Composite',
      class_name: 'HostName',
      model_properties: {
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        site_names: {
          required: false,
          serialized_name: 'siteNames',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        azure_resource_name: {
          required: false,
          serialized_name: 'azureResourceName',
          type: {
            name: 'String'
          }
        },
        azure_resource_type: {
          required: false,
          serialized_name: 'azureResourceType',
          type: {
            name: 'Enum',
            module: 'AzureResourceType'
          }
        },
        custom_host_name_dns_record_type: {
          required: false,
          serialized_name: 'customHostNameDnsRecordType',
          type: {
            name: 'Enum',
            module: 'CustomHostNameDnsRecordType'
          }
        },
        host_name_type: {
          required: false,
          serialized_name: 'hostNameType',
          type: {
            name: 'Enum',
            module: 'HostNameType'
          }
        }
      }
    }
  }
end