-
Notifications
You must be signed in to change notification settings - Fork 181
/
CheckNameAvailabilityOutput.yml
63 lines (60 loc) · 1.96 KB
/
CheckNameAvailabilityOutput.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
### YamlMime:TSType
name: CheckNameAvailabilityOutput
uid: '@azure/arm-search.CheckNameAvailabilityOutput'
package: '@azure/arm-search'
summary: Output of check name availability API.
fullName: CheckNameAvailabilityOutput
remarks: ''
isDeprecated: false
type: interface
properties:
- name: isNameAvailable
uid: '@azure/arm-search.CheckNameAvailabilityOutput.isNameAvailable'
package: '@azure/arm-search'
summary: >-
A value indicating whether the name is available.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: isNameAvailable
remarks: ''
isDeprecated: false
syntax:
content: 'isNameAvailable?: boolean'
return:
description: ''
type: boolean
- name: message
uid: '@azure/arm-search.CheckNameAvailabilityOutput.message'
package: '@azure/arm-search'
summary: >-
A message that explains why the name is invalid and provides resource
naming requirements. Available only if 'Invalid' is returned in the
'reason' property.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: message
remarks: ''
isDeprecated: false
syntax:
content: 'message?: string'
return:
description: ''
type: string
- name: reason
uid: '@azure/arm-search.CheckNameAvailabilityOutput.reason'
package: '@azure/arm-search'
summary: >-
The reason why the name is not available. 'Invalid' indicates the name
provided does not match the naming requirements (incorrect length,
unsupported characters, etc.). 'AlreadyExists' indicates that the name is
already in use and is therefore unavailable.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: reason
remarks: ''
isDeprecated: false
syntax:
content: 'reason?: string'
return:
description: ''
type: string