-
Notifications
You must be signed in to change notification settings - Fork 181
/
ContainerRepository.yml
226 lines (193 loc) · 6.79 KB
/
ContainerRepository.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
### YamlMime:TSType
name: ContainerRepository
uid: '@azure/container-registry.ContainerRepository'
package: '@azure/container-registry'
summary: >-
A `repository` in a container registry is a logical grouping of images or
artifacts that share the same name. For example,
different versions of a `hello-world` application could have tags `v1` and
`v2`, and be grouped by the repository `hello-world`.
The [ContainerRepository](xref:@azure/container-registry.ContainerRepository)
interface is a helper that groups information and operations about a
repository in this
container registry.
fullName: ContainerRepository
remarks: ''
isDeprecated: false
type: interface
properties:
- name: name
uid: '@azure/container-registry.ContainerRepository.name'
package: '@azure/container-registry'
summary: Repository name.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: registryEndpoint
uid: '@azure/container-registry.ContainerRepository.registryEndpoint'
package: '@azure/container-registry'
summary: The Azure Container Registry endpoint.
fullName: registryEndpoint
remarks: ''
isDeprecated: false
syntax:
content: 'registryEndpoint: string'
return:
description: ''
type: string
methods:
- name: delete(DeleteRepositoryOptions)
uid: '@azure/container-registry.ContainerRepository.delete'
package: '@azure/container-registry'
summary: >-
Deletes this repository and all artifacts that are part of its logical
group.
remarks: ''
isDeprecated: false
syntax:
content: 'function delete(options?: DeleteRepositoryOptions): Promise<void>'
parameters:
- id: options
type: <xref uid="@azure/container-registry.DeleteRepositoryOptions" />
description: optional configuration for the operation
return:
description: ''
type: Promise<void>
- name: getArtifact(string)
uid: '@azure/container-registry.ContainerRepository.getArtifact'
package: '@azure/container-registry'
summary: >-
Returns an helper instance of
[RegistryArtifact](xref:@azure/container-registry.RegistryArtifact) for
the given tag or digest.
remarks: ''
isDeprecated: false
syntax:
content: 'function getArtifact(tagOrDigest: string): RegistryArtifact'
parameters:
- id: tagOrDigest
type: string
description: the tag or digest of the artifact
return:
description: ''
type: <xref uid="@azure/container-registry.RegistryArtifact" />
- name: getProperties(GetRepositoryPropertiesOptions)
uid: '@azure/container-registry.ContainerRepository.getProperties'
package: '@azure/container-registry'
summary: Retrieves the properties of this repository.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getProperties(options?: GetRepositoryPropertiesOptions):
Promise<ContainerRepositoryProperties>
parameters:
- id: options
type: >-
<xref uid="@azure/container-registry.GetRepositoryPropertiesOptions"
/>
description: ''
return:
description: ''
type: >-
Promise<<xref
uid="@azure/container-registry.ContainerRepositoryProperties" />>
- name: listManifestProperties(ListManifestPropertiesOptions)
uid: '@azure/container-registry.ContainerRepository.listManifestProperties'
package: '@azure/container-registry'
summary: >-
Returns an async iterable iterator to list manifest properties.
This is useful for determining the collection of artifacts associated with
this repository, as each artifact is uniquely identified by its manifest.
Example using `for-await-of` syntax:
```javascript
const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
console.log("manifest: ", manifest);
}
```
Example using `iter.next()`:
```javascript
const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
console.log("manifest properties: ", item.value);
item = await iter.next();
}
```
Example using `byPage()`:
```javascript
const pages = repository.listManifestProperties().byPage({ maxPageSize: 2
});
let page = await pages.next();
let i = 1;
while (!page.done) {
if (page.value) {
console.log(`-- page ${i++}`);
for (const manifestProperties of page.value) {
console.log(` manifest properties: ${manifestProperties}`);
}
}
page = await pages.next();
}
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function listManifestProperties(options?:
ListManifestPropertiesOptions):
PagedAsyncIterableIterator<ArtifactManifestProperties,
ArtifactManifestProperties[], PageSettings>
parameters:
- id: options
type: >-
<xref uid="@azure/container-registry.ListManifestPropertiesOptions"
/>
description: ''
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/container-registry.ArtifactManifestProperties" />, <xref
uid="@azure/container-registry.ArtifactManifestProperties" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: updateProperties(UpdateRepositoryPropertiesOptions)
uid: '@azure/container-registry.ContainerRepository.updateProperties'
package: '@azure/container-registry'
summary: |-
Updates the properties of this repository.
Example usage:
```javascript
const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
canDelete: false,
canList: false,
canRead: false,
canWrite: false
});
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function updateProperties(options: UpdateRepositoryPropertiesOptions):
Promise<ContainerRepositoryProperties>
parameters:
- id: options
type: >-
<xref
uid="@azure/container-registry.UpdateRepositoryPropertiesOptions" />
description: ''
return:
description: ''
type: >-
Promise<<xref
uid="@azure/container-registry.ContainerRepositoryProperties" />>