Class: Azure::KeyVault::Mgmt::V2019_09_01::Models::CheckNameAvailabilityResult

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-01/generated/azure_mgmt_key_vault/models/check_name_availability_result.rb

Overview

The CheckNameAvailability operation response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#message ⇒ String

detail.

Returns:

  • (String) —

    An error message explaining the Reason value in more



27
28
29
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/check_name_availability_result.rb', line 27

def message
  @message
end

#name_available ⇒ Boolean

available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.

Returns:

  • (Boolean) —

    A boolean value that indicates whether the name is



18
19
20
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/check_name_availability_result.rb', line 18

def name_available
  @name_available
end

#reason ⇒ Reason

Reason element is only returned if NameAvailable is false. Possible values include: ‘AccountNameInvalid’, ‘AlreadyExists’

Returns:

  • (Reason) —

    The reason that a vault name could not be used. The



23
24
25
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/check_name_availability_result.rb', line 23

def reason
  @reason
end

Class Method Details

.mapper ⇒ Object

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



34
35
36
37
38
39
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
 
# File 'lib/2019-09-01/generated/azure_mgmt_key_vault/models/check_name_availability_result.rb', line 34

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