Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::ApiManagementServiceNameAvailabilityResult

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

Overview

Response of the CheckNameAvailability operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#message ⇒ String

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 <resourceName> is already in use, and direct them to select a different name.

Returns:

  • (String) —

    If reason == invalid, provide the user with the reason



24
25
26
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_name_availability_result.rb', line 24

def message
  @message
end

#name_available ⇒ Boolean

create a new API Management service; otherwise false.

Returns:

  • (Boolean) —

    True if the name is available and can be used to



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

def name_available
  @name_available
end

#reason ⇒ NameAvailabilityReason

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: ‘Valid’, ‘Invalid’, ‘AlreadyExists’

Returns:



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

def reason
  @reason
end

Class Method Details

.mapper ⇒ Object

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



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
75
76
77
78
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_management_service_name_availability_result.rb', line 39

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