-
Notifications
You must be signed in to change notification settings - Fork 180
/
RestorableDatabaseAccounts.yml
120 lines (116 loc) · 4.38 KB
/
RestorableDatabaseAccounts.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
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
110
111
112
113
114
115
116
117
118
119
120
### YamlMime:TSType
name: RestorableDatabaseAccounts
uid: '@azure/arm-cosmosdb.RestorableDatabaseAccounts'
package: '@azure/arm-cosmosdb'
summary: Interface representing a RestorableDatabaseAccounts.
fullName: RestorableDatabaseAccounts
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
getByLocation(string, string,
RestorableDatabaseAccountsGetByLocationOptionalParams)
uid: '@azure/arm-cosmosdb.RestorableDatabaseAccounts.getByLocation'
package: '@azure/arm-cosmosdb'
summary: >-
Retrieves the properties of an existing Azure Cosmos DB restorable
database account. This call
requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*'
permission.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getByLocation(location: string, instanceId: string, options?:
RestorableDatabaseAccountsGetByLocationOptionalParams):
Promise<RestorableDatabaseAccountGetResult>
parameters:
- id: location
type: string
description: >-
Cosmos DB region, with spaces between words and each word
capitalized.
- id: instanceId
type: string
description: The instanceId GUID of a restorable database account.
- id: options
type: >-
<xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountsGetByLocationOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountGetResult" />>
- name: list(RestorableDatabaseAccountsListOptionalParams)
uid: '@azure/arm-cosmosdb.RestorableDatabaseAccounts.list'
package: '@azure/arm-cosmosdb'
summary: >-
Lists all the restorable Azure Cosmos DB database accounts available under
the subscription. This
call requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read'
permission.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(options?: RestorableDatabaseAccountsListOptionalParams):
PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult,
RestorableDatabaseAccountGetResult[], PageSettings>
parameters:
- id: options
type: >-
<xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountsListOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountGetResult" />, <xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountGetResult" />[],
<xref uid="@azure/core-paging.PageSettings" />>
- name: >-
listByLocation(string,
RestorableDatabaseAccountsListByLocationOptionalParams)
uid: '@azure/arm-cosmosdb.RestorableDatabaseAccounts.listByLocation'
package: '@azure/arm-cosmosdb'
summary: >-
Lists all the restorable Azure Cosmos DB database accounts available under
the subscription and in a
region. This call requires
'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read'
permission.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByLocation(location: string, options?:
RestorableDatabaseAccountsListByLocationOptionalParams):
PagedAsyncIterableIterator<RestorableDatabaseAccountGetResult,
RestorableDatabaseAccountGetResult[], PageSettings>
parameters:
- id: location
type: string
description: >-
Cosmos DB region, with spaces between words and each word
capitalized.
- id: options
type: >-
<xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountsListByLocationOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountGetResult" />, <xref
uid="@azure/arm-cosmosdb.RestorableDatabaseAccountGetResult" />[],
<xref uid="@azure/core-paging.PageSettings" />>