/
index.ts
3919 lines (3466 loc) · 139 KB
/
index.ts
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreClient from "@azure/core-client";
export type RunRequestUnion =
| RunRequest
| DockerBuildRequest
| FileTaskRunRequest
| TaskRunRequest
| EncodedTaskRunRequest;
export type TaskStepPropertiesUnion =
| TaskStepProperties
| DockerBuildStep
| FileTaskStep
| EncodedTaskStep;
export type TaskStepUpdateParametersUnion =
| TaskStepUpdateParameters
| DockerBuildStepUpdateParameters
| FileTaskStepUpdateParameters
| EncodedTaskStepUpdateParameters;
/** The result of a request to list connected registries for a container registry. */
export interface ConnectedRegistryListResult {
/** The list of connected registries. Since this list may be incomplete, the nextLink field should be used to request the next list of connected registries. */
value?: ConnectedRegistry[];
/** The URI that can be used to request the next list of connected registries. */
nextLink?: string;
}
/** The activation properties of the connected registry. */
export interface ActivationProperties {
/**
* The activation status of the connected registry.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: ActivationStatus;
}
/** The properties of the connected registry parent. */
export interface ParentProperties {
/** The resource ID of the parent to which the connected registry will be associated. */
id?: string;
/** The sync properties of the connected registry with its parent. */
syncProperties: SyncProperties;
}
/** The sync properties of the connected registry with its parent. */
export interface SyncProperties {
/** The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. */
tokenId: string;
/** The cron expression indicating the schedule that the connected registry will sync with its parent. */
schedule?: string;
/** The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. */
syncWindow?: string;
/** The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. */
messageTtl: string;
/**
* The last time a sync occurred between the connected registry and its parent.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastSyncTime?: Date;
/**
* The gateway endpoint used by the connected registry to communicate with its parent.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly gatewayEndpoint?: string;
}
/** The login server properties of the connected registry. */
export interface LoginServerProperties {
/**
* The host of the connected registry. Can be FQDN or IP.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly host?: string;
/**
* The TLS properties of the connected registry login server.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tls?: TlsProperties;
}
/** The TLS properties of the connected registry login server. */
export interface TlsProperties {
/**
* Indicates whether HTTPS is enabled for the login server.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: TlsStatus;
/**
* The certificate used to configure HTTPS for the login server.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly certificate?: TlsCertificateProperties;
}
/** The TLS certificate properties of the connected registry login server. */
export interface TlsCertificateProperties {
/**
* The type of certificate location.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: CertificateType;
/**
* Indicates the location of the certificates.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
}
/** The logging properties of the connected registry. */
export interface LoggingProperties {
/** The verbosity of logs persisted on the connected registry. */
logLevel?: LogLevel;
/** Indicates whether audit logs are enabled on the connected registry. */
auditLogStatus?: AuditLogStatus;
}
/** The status detail properties of the connected registry. */
export interface StatusDetailProperties {
/**
* The component of the connected registry corresponding to the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The code of the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* The description of the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly description?: string;
/**
* The timestamp of the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timestamp?: Date;
/**
* The correlation ID of the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly correlationId?: string;
}
/** The resource model definition for a ARM proxy resource. It will have everything other than required location and tags. */
export interface ProxyResource {
/**
* The resource ID.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Metadata pertaining to creation and last modification of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly systemData?: SystemData;
}
/** Metadata pertaining to creation and last modification of the resource. */
export interface SystemData {
/** The identity that created the resource. */
createdBy?: string;
/** The type of identity that created the resource. */
createdByType?: CreatedByType;
/** The timestamp of resource creation (UTC). */
createdAt?: Date;
/** The identity that last modified the resource. */
lastModifiedBy?: string;
/** The type of identity that last modified the resource. */
lastModifiedByType?: LastModifiedByType;
/** The timestamp of resource modification (UTC). */
lastModifiedAt?: Date;
}
/** An error response from the Azure Container Registry service. */
export interface ErrorResponse {
/** Azure container registry build API error body. */
error?: ErrorResponseBody;
}
/** An error response from the Azure Container Registry service. */
export interface ErrorResponseBody {
/** error code. */
code: string;
/** error message. */
message: string;
/** target of the particular error. */
target?: string;
/** an array of additional nested error response info objects, as described by this contract. */
details?: InnerErrorDescription[];
}
/** inner error. */
export interface InnerErrorDescription {
/** error code. */
code: string;
/** error message. */
message: string;
/** target of the particular error. */
target?: string;
}
/** The parameters for updating a connected registry. */
export interface ConnectedRegistryUpdateParameters {
/** The sync properties of the connected registry with its parent. */
syncProperties?: SyncUpdateProperties;
/** The logging properties of the connected registry. */
logging?: LoggingProperties;
/** The list of the ACR token resource IDs used to authenticate clients to the connected registry. */
clientTokenIds?: string[];
/** The list of notifications subscription information for the connected registry. */
notificationsList?: string[];
}
/** The parameters for updating the sync properties of the connected registry with its parent. */
export interface SyncUpdateProperties {
/** The cron expression indicating the schedule that the connected registry will sync with its parent. */
schedule?: string;
/** The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. */
syncWindow?: string;
/** The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. */
messageTtl?: string;
}
/** The result of a request to list export pipelines for a container registry. */
export interface ExportPipelineListResult {
/** The list of export pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of export pipelines. */
value?: ExportPipeline[];
/** The URI that can be used to request the next list of pipeline runs. */
nextLink?: string;
}
/** Managed identity for the resource. */
export interface IdentityProperties {
/** The principal ID of resource identity. */
principalId?: string;
/** The tenant ID of resource. */
tenantId?: string;
/** The identity type. */
type?: ResourceIdentityType;
/**
* The list of user identities associated with the resource. The user identity
* dictionary key references will be ARM resource ids in the form:
* '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
* providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
*/
userAssignedIdentities?: { [propertyName: string]: UserIdentityProperties };
}
export interface UserIdentityProperties {
/** The principal id of user assigned identity. */
principalId?: string;
/** The client id of user assigned identity. */
clientId?: string;
}
/** The properties of the export pipeline target. */
export interface ExportPipelineTargetProperties {
/** The type of target for the export pipeline. */
type?: string;
/**
* The target uri of the export pipeline.
* When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"
* When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName"
*/
uri?: string;
/** They key vault secret uri to obtain the target storage SAS token. */
keyVaultUri: string;
}
export interface ImportImageParameters {
/** The source of the image. */
source: ImportSource;
/** List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted). */
targetTags?: string[];
/** List of strings of repository names to do a manifest only copy. No tag will be created. */
untaggedTargetRepositories?: string[];
/** When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins. */
mode?: ImportMode;
}
export interface ImportSource {
/** The resource identifier of the source Azure Container Registry. */
resourceId?: string;
/** The address of the source registry (e.g. 'mcr.microsoft.com'). */
registryUri?: string;
/** Credentials used when importing from a registry uri. */
credentials?: ImportSourceCredentials;
/**
* Repository name of the source image.
* Specify an image by repository ('hello-world'). This will use the 'latest' tag.
* Specify an image by tag ('hello-world:latest').
* Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123').
*/
sourceImage: string;
}
export interface ImportSourceCredentials {
/** The username to authenticate with the source registry. */
username?: string;
/** The password used to authenticate with the source registry. */
password: string;
}
/** The result of a request to list import pipelines for a container registry. */
export interface ImportPipelineListResult {
/** The list of import pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of import pipelines. */
value?: ImportPipeline[];
/** The URI that can be used to request the next list of pipeline runs. */
nextLink?: string;
}
/** The properties of the import pipeline source. */
export interface ImportPipelineSourceProperties {
/** The type of source for the import pipeline. */
type?: PipelineSourceType;
/**
* The source uri of the import pipeline.
* When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"
* When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName"
*/
uri?: string;
/** They key vault secret uri to obtain the source storage SAS token. */
keyVaultUri: string;
}
export interface PipelineTriggerProperties {
/** The source trigger properties of the pipeline. */
sourceTrigger?: PipelineSourceTriggerProperties;
}
export interface PipelineSourceTriggerProperties {
/** The current status of the source trigger. */
status: TriggerStatus;
}
/** The result of a request to list container registry operations. */
export interface OperationListResult {
/** The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations. */
value?: OperationDefinition[];
/** The URI that can be used to request the next list of container registry operations. */
nextLink?: string;
}
/** The definition of a container registry operation. */
export interface OperationDefinition {
/** The origin information of the container registry operation. */
origin?: string;
/** Operation name: {provider}/{resource}/{operation}. */
name?: string;
/** The display information for the container registry operation. */
display?: OperationDisplayDefinition;
/**
* This property indicates if the operation is an action or a data action
* ref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations
*/
isDataAction?: boolean;
/** The definition of Azure Monitoring service. */
serviceSpecification?: OperationServiceSpecificationDefinition;
}
/** The display information for a container registry operation. */
export interface OperationDisplayDefinition {
/** The resource provider name: Microsoft.ContainerRegistry. */
provider?: string;
/** The resource on which the operation is performed. */
resource?: string;
/** The operation that users can perform. */
operation?: string;
/** The description for the operation. */
description?: string;
}
/** The definition of Azure Monitoring list. */
export interface OperationServiceSpecificationDefinition {
/** A list of Azure Monitoring metrics definition. */
metricSpecifications?: OperationMetricSpecificationDefinition[];
/** A list of Azure Monitoring log definitions. */
logSpecifications?: OperationLogSpecificationDefinition[];
}
/** The definition of Azure Monitoring metric. */
export interface OperationMetricSpecificationDefinition {
/** Metric name. */
name?: string;
/** Metric display name. */
displayName?: string;
/** Metric description. */
displayDescription?: string;
/** Metric unit. */
unit?: string;
/** Metric aggregation type. */
aggregationType?: string;
/** Internal metric name. */
internalMetricName?: string;
}
/** The definition of Azure Monitoring log. */
export interface OperationLogSpecificationDefinition {
/** Log name. */
name?: string;
/** Log display name. */
displayName?: string;
/** Log blob duration. */
blobDuration?: string;
}
/** A request to check whether a container registry name is available. */
export interface RegistryNameCheckRequest {
/** The name of the container registry. */
name: string;
/** The resource type of the container registry. This field must be set to 'Microsoft.ContainerRegistry/registries'. */
type: "Microsoft.ContainerRegistry/registries";
}
/** The result of a request to check the availability of a container registry name. */
export interface RegistryNameStatus {
/** The value that indicates whether the name is available. */
nameAvailable?: boolean;
/** If any, the reason that the name is not available. */
reason?: string;
/** If any, the error message that provides more detail for the reason that the name is not available. */
message?: string;
}
/** The result of a request to list pipeline runs for a container registry. */
export interface PipelineRunListResult {
/** The list of pipeline runs. Since this list may be incomplete, the nextLink field should be used to request the next list of pipeline runs. */
value?: PipelineRun[];
/** The URI that can be used to request the next list of pipeline runs. */
nextLink?: string;
}
/** The request properties provided for a pipeline run. */
export interface PipelineRunRequest {
/** The resource ID of the pipeline to run. */
pipelineResourceId?: string;
/**
* List of source artifacts to be transferred by the pipeline.
* Specify an image by repository ('hello-world'). This will use the 'latest' tag.
* Specify an image by tag ('hello-world:latest').
* Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123').
*/
artifacts?: string[];
/** The source properties of the pipeline run. */
source?: PipelineRunSourceProperties;
/** The target properties of the pipeline run. */
target?: PipelineRunTargetProperties;
/** The digest of the tar used to transfer the artifacts. */
catalogDigest?: string;
}
export interface PipelineRunSourceProperties {
/** The type of the source. */
type?: PipelineRunSourceType;
/** The name of the source. */
name?: string;
}
export interface PipelineRunTargetProperties {
/** The type of the target. */
type?: PipelineRunTargetType;
/** The name of the target. */
name?: string;
}
/** The response properties returned for a pipeline run. */
export interface PipelineRunResponse {
/** The current status of the pipeline run. */
status?: string;
/** The artifacts imported in the pipeline run. */
importedArtifacts?: string[];
/** The current progress of the copy operation. */
progress?: ProgressProperties;
/** The time the pipeline run started. */
startTime?: Date;
/** The time the pipeline run finished. */
finishTime?: Date;
/** The source of the pipeline run. */
source?: ImportPipelineSourceProperties;
/** The target of the pipeline run. */
target?: ExportPipelineTargetProperties;
/** The digest of the tar used to transfer the artifacts. */
catalogDigest?: string;
/** The trigger that caused the pipeline run. */
trigger?: PipelineTriggerDescriptor;
/** The detailed error message for the pipeline run in the case of failure. */
pipelineRunErrorMessage?: string;
}
export interface ProgressProperties {
/** The percentage complete of the copy operation. */
percentage?: string;
}
export interface PipelineTriggerDescriptor {
/** The source trigger that caused the pipeline run. */
sourceTrigger?: PipelineSourceTriggerDescriptor;
}
export interface PipelineSourceTriggerDescriptor {
/** The timestamp when the source update happened. */
timestamp?: Date;
}
/** The result of a request to list private endpoint connections for a container registry. */
export interface PrivateEndpointConnectionListResult {
/** The list of private endpoint connections. Since this list may be incomplete, the nextLink field should be used to request the next list of private endpoint connections. */
value?: PrivateEndpointConnection[];
/** The URI that can be used to request the next list of private endpoint connections. */
nextLink?: string;
}
/** The Private Endpoint resource. */
export interface PrivateEndpoint {
/** This is private endpoint resource created with Microsoft.Network resource provider. */
id?: string;
}
/** The state of a private link service connection. */
export interface PrivateLinkServiceConnectionState {
/** The private link service connection status. */
status?: ConnectionStatus;
/** The description for connection status. For example if connection is rejected it can indicate reason for rejection. */
description?: string;
/** A message indicating if changes on the service provider require any updates on the consumer. */
actionsRequired?: ActionsRequired;
}
/** The result of a request to list container registries. */
export interface RegistryListResult {
/** The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries. */
value?: Registry[];
/** The URI that can be used to request the next list of container registries. */
nextLink?: string;
}
/** The SKU of a container registry. */
export interface Sku {
/** The SKU name of the container registry. Required for registry creation. */
name: SkuName;
/**
* The SKU tier based on the SKU name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tier?: SkuTier;
}
/** The status of an Azure resource at the time the operation was called. */
export interface Status {
/**
* The short label for the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly displayStatus?: string;
/**
* The detailed message for the status, including alerts and error messages.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly message?: string;
/**
* The timestamp when the status was changed to the current value.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timestamp?: Date;
}
/** The network rule set for a container registry. */
export interface NetworkRuleSet {
/** The default action of allow or deny when no other rules match. */
defaultAction: DefaultAction;
/** The virtual network rules. */
virtualNetworkRules?: VirtualNetworkRule[];
/** The IP ACL rules. */
ipRules?: IPRule[];
}
/** Virtual network rule. */
export interface VirtualNetworkRule {
/** The action of virtual network rule. */
action?: Action;
/** Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. */
virtualNetworkResourceId: string;
}
/** IP rule with specific IP or IP range in CIDR format. */
export interface IPRule {
/** The action of IP ACL rule. */
action?: Action;
/** Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. */
iPAddressOrRange: string;
}
/** The policies for a container registry. */
export interface Policies {
/** The quarantine policy for a container registry. */
quarantinePolicy?: QuarantinePolicy;
/** The content trust policy for a container registry. */
trustPolicy?: TrustPolicy;
/** The retention policy for a container registry. */
retentionPolicy?: RetentionPolicy;
/** The export policy for a container registry. */
exportPolicy?: ExportPolicy;
}
/** The quarantine policy for a container registry. */
export interface QuarantinePolicy {
/** The value that indicates whether the policy is enabled or not. */
status?: PolicyStatus;
}
/** The content trust policy for a container registry. */
export interface TrustPolicy {
/** The type of trust policy. */
type?: TrustPolicyType;
/** The value that indicates whether the policy is enabled or not. */
status?: PolicyStatus;
}
/** The retention policy for a container registry. */
export interface RetentionPolicy {
/** The number of days to retain an untagged manifest after which it gets purged. */
days?: number;
/**
* The timestamp when the policy was last updated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastUpdatedTime?: Date;
/** The value that indicates whether the policy is enabled or not. */
status?: PolicyStatus;
}
/** The export policy for a container registry. */
export interface ExportPolicy {
/** The value that indicates whether the policy is enabled or not. */
status?: ExportPolicyStatus;
}
export interface EncryptionProperty {
/** Indicates whether or not the encryption is enabled for container registry. */
status?: EncryptionStatus;
/** Key vault properties. */
keyVaultProperties?: KeyVaultProperties;
}
export interface KeyVaultProperties {
/** Key vault uri to access the encryption key. */
keyIdentifier?: string;
/**
* The fully qualified key identifier that includes the version of the key that is actually used for encryption.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly versionedKeyIdentifier?: string;
/** The client id of the identity which will be used to access key vault. */
identity?: string;
/**
* Auto key rotation status for a CMK enabled registry.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly keyRotationEnabled?: boolean;
/**
* Timestamp of the last successful key rotation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastKeyRotationTimestamp?: Date;
}
/** An Azure resource. */
export interface Resource {
/**
* The resource ID.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** The location of the resource. This cannot be changed after the resource is created. */
location: string;
/** The tags of the resource. */
tags?: { [propertyName: string]: string };
/**
* Metadata pertaining to creation and last modification of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly systemData?: SystemData;
}
/** The parameters for updating a container registry. */
export interface RegistryUpdateParameters {
/** The identity of the container registry. */
identity?: IdentityProperties;
/** The tags for the container registry. */
tags?: { [propertyName: string]: string };
/** The SKU of the container registry. */
sku?: Sku;
/** The value that indicates whether the admin user is enabled. */
adminUserEnabled?: boolean;
/** The network rule set for a container registry. */
networkRuleSet?: NetworkRuleSet;
/** The policies for a container registry. */
policies?: Policies;
/** The encryption settings of container registry. */
encryption?: EncryptionProperty;
/** Enable a single data endpoint per region for serving data. */
dataEndpointEnabled?: boolean;
/** Whether or not public network access is allowed for the container registry. */
publicNetworkAccess?: PublicNetworkAccess;
/** Whether to allow trusted Azure services to access a network restricted registry. */
networkRuleBypassOptions?: NetworkRuleBypassOptions;
/** Enables registry-wide pull from unauthenticated clients. */
anonymousPullEnabled?: boolean;
}
/** The result of a request to get container registry quota usages. */
export interface RegistryUsageListResult {
/** The list of container registry quota usages. */
value?: RegistryUsage[];
}
/** The quota usage for a container registry. */
export interface RegistryUsage {
/** The name of the usage. */
name?: string;
/** The limit of the usage. */
limit?: number;
/** The current value of the usage. */
currentValue?: number;
/** The unit of measurement. */
unit?: RegistryUsageUnit;
}
/** The result of a request to list private link resources for a container registry. */
export interface PrivateLinkResourceListResult {
/** The list of private link resources. Since this list may be incomplete, the nextLink field should be used to request the next list of private link resources. */
value?: PrivateLinkResource[];
/** The URI that can be used to request the next list of private link resources. */
nextLink?: string;
}
/** A resource that supports private link capabilities. */
export interface PrivateLinkResource {
/**
* The resource type is private link resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** The resource ID. */
id?: string;
/** The name of the resource. */
name?: string;
/** The private link resource group id. */
groupId?: string;
/** The private link resource required member names. */
requiredMembers?: string[];
/** The private link resource Private link DNS zone name. */
requiredZoneNames?: string[];
}
/** The response from the ListCredentials operation. */
export interface RegistryListCredentialsResult {
/** The username for a container registry. */
username?: string;
/** The list of passwords for a container registry. */
passwords?: RegistryPassword[];
}
/** The login password for the container registry. */
export interface RegistryPassword {
/** The password name. */
name?: PasswordName;
/** The password value. */
value?: string;
}
/** The parameters used to regenerate the login credential. */
export interface RegenerateCredentialParameters {
/** Specifies name of the password which should be regenerated -- password or password2. */
name: PasswordName;
}
/** The result of a request to list replications for a container registry. */
export interface ReplicationListResult {
/** The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications. */
value?: Replication[];
/** The URI that can be used to request the next list of replications. */
nextLink?: string;
}
/** The parameters for updating a replication. */
export interface ReplicationUpdateParameters {
/** The tags for the replication. */
tags?: { [propertyName: string]: string };
/** Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. */
regionEndpointEnabled?: boolean;
}
/** The result of a request to list scope maps for a container registry. */
export interface ScopeMapListResult {
/** The list of scope maps. Since this list may be incomplete, the nextLink field should be used to request the next list of scope maps. */
value?: ScopeMap[];
/** The URI that can be used to request the next list of scope maps. */
nextLink?: string;
}
/** The properties for updating the scope map. */
export interface ScopeMapUpdateParameters {
/** The user friendly description of the scope map. */
description?: string;
/**
* The list of scope permissions for registry artifacts.
* E.g. repositories/repository-name/pull,
* repositories/repository-name/delete
*/
actions?: string[];
}
/** The result of a request to list tokens for a container registry. */
export interface TokenListResult {
/** The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens. */
value?: Token[];
/** The URI that can be used to request the next list of tokens. */
nextLink?: string;
}
/** The properties of the credentials that can be used for authenticating the token. */
export interface TokenCredentialsProperties {
certificates?: TokenCertificate[];
passwords?: TokenPassword[];
}
/** The properties of a certificate used for authenticating a token. */
export interface TokenCertificate {
name?: TokenCertificateName;
/** The expiry datetime of the certificate. */
expiry?: Date;
/** The thumbprint of the certificate. */
thumbprint?: string;
/** Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. */
encodedPemCertificate?: string;
}
/** The password that will be used for authenticating the token of a container registry. */
export interface TokenPassword {
/** The creation datetime of the password. */
creationTime?: Date;
/** The expiry datetime of the password. */
expiry?: Date;
/** The password name "password1" or "password2" */
name?: TokenPasswordName;
/**
* The password value.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: string;
}
/** The parameters for updating a token. */
export interface TokenUpdateParameters {
/** The resource ID of the scope map to which the token will be associated with. */
scopeMapId?: string;
/** The status of the token example enabled or disabled. */
status?: TokenStatus;
/** The credentials that can be used for authenticating the token. */
credentials?: TokenCredentialsProperties;
}
/** The parameters used to generate credentials for a specified token or user of a container registry. */
export interface GenerateCredentialsParameters {
/** The resource ID of the token for which credentials have to be generated. */
tokenId?: string;
/** The expiry date of the generated credentials after which the credentials become invalid. */
expiry?: Date;
/** Specifies name of the password which should be regenerated if any -- password1 or password2. */
name?: TokenPasswordName;
}
/** The response from the GenerateCredentials operation. */
export interface GenerateCredentialsResult {
/** The username for a container registry. */
username?: string;
/** The list of passwords for a container registry. */
passwords?: TokenPassword[];
}
/** The result of a request to list webhooks for a container registry. */
export interface WebhookListResult {
/** The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks. */
value?: Webhook[];
/** The URI that can be used to request the next list of webhooks. */
nextLink?: string;
}
/** The parameters for creating a webhook. */
export interface WebhookCreateParameters {
/** The tags for the webhook. */
tags?: { [propertyName: string]: string };
/** The location of the webhook. This cannot be changed after the resource is created. */
location: string;
/** The service URI for the webhook to post notifications. */
serviceUri?: string;
/** Custom headers that will be added to the webhook notifications. */
customHeaders?: { [propertyName: string]: string };
/** The status of the webhook at the time the operation was called. */
status?: WebhookStatus;
/** The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. */
scope?: string;
/** The list of actions that trigger the webhook to post notifications. */
actions?: WebhookAction[];
}
/** The parameters for updating a webhook. */
export interface WebhookUpdateParameters {
/** The tags for the webhook. */
tags?: { [propertyName: string]: string };
/** The service URI for the webhook to post notifications. */
serviceUri?: string;
/** Custom headers that will be added to the webhook notifications. */
customHeaders?: { [propertyName: string]: string };
/** The status of the webhook at the time the operation was called. */
status?: WebhookStatus;
/** The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. */
scope?: string;
/** The list of actions that trigger the webhook to post notifications. */
actions?: WebhookAction[];
}
/** The basic information of an event. */
export interface EventInfo {
/** The event ID. */
id?: string;
}
/** The result of a request to list events for a webhook. */
export interface EventListResult {
/** The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. */
value?: Event[];
/** The URI that can be used to request the next list of events. */
nextLink?: string;
}
/** The event request message sent to the service URI. */
export interface EventRequestMessage {
/** The content of the event request message. */
content?: EventContent;
/** The headers of the event request message. */
headers?: { [propertyName: string]: string };
/** The HTTP method used to send the event request message. */
method?: string;
/** The URI used to send the event request message. */
requestUri?: string;
/** The HTTP message version. */
version?: string;
}
/** The content of the event request message. */
export interface EventContent {
/** The event ID. */
id?: string;
/** The time at which the event occurred. */
timestamp?: Date;
/** The action that encompasses the provided event. */
action?: string;
/** The target of the event. */
target?: Target;
/** The request that generated the event. */
request?: Request;
/** The agent that initiated the event. For most situations, this could be from the authorization context of the request. */
actor?: Actor;
/** The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. */
source?: Source;
}
/** The target of the event. */