Class: Azure::ResourcesManagement::Mgmt::V2018_03_01_preview::Models::CheckNameAvailabilityResult

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-03-01-preview/generated/azure_mgmt_resources_management/models/check_name_availability_result.rb

Overview

Describes the result of the request to check management group name availability.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#message ⇒ String

reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.



33
34
35
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_resources_management/models/check_name_availability_result.rb', line 33

def message
  @message
end

#name_available ⇒ Boolean

False indicates the name is invalid, unavailable, or both.



18
19
20
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_resources_management/models/check_name_availability_result.rb', line 18

def name_available
  @name_available
end

#reason ⇒ Reason

the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’



26
27
28
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_resources_management/models/check_name_availability_result.rb', line 26

def reason
  @reason
end

Class Method Details

.mapper ⇒ Object

Mapper for CheckNameAvailabilityResult 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
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_resources_management/models/check_name_availability_result.rb', line 40

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'CheckNameAvailabilityResult',
    type: {
      name: 'Composite',
      class_name: 'CheckNameAvailabilityResult',
      model_properties: {
        name_available: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'nameAvailable',
          type: {
            name: 'Boolean'
          }
        },
        reason: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'reason',
          type: {
            name: 'Enum',
            module: 'Reason'
          }
        },
        message: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end