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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
|
# pylint: disable=too-many-lines
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
from .._utils import serialization as _serialization
if TYPE_CHECKING:
from .. import models as _models
class AzureResourceBase(_serialization.Model):
"""Common properties for all Azure resources.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: String Id used to locate any resource on Azure.
:vartype id: str
:ivar name: Name of this resource.
:vartype name: str
:ivar type: Type of this resource.
:vartype type: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id: Optional[str] = None
self.name: Optional[str] = None
self.type: Optional[str] = None
class DeploymentScript(AzureResourceBase):
"""Deployment script object.
You probably want to use the sub-classes and not this class directly. Known sub-classes are:
AzureCliScript, AzurePowerShellScript
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar id: String Id used to locate any resource on Azure.
:vartype id: str
:ivar name: Name of this resource.
:vartype name: str
:ivar type: Type of this resource.
:vartype type: str
:ivar identity: Optional property. Managed identity to be used for this deployment script.
Currently, only user-assigned MSI is supported.
:vartype identity: ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentity
:ivar location: The location of the ACI and the storage account for the deployment script.
Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar kind: Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".
:vartype kind: str or ~azure.mgmt.resource.deploymentscripts.models.ScriptType
:ivar system_data: The system metadata related to this resource.
:vartype system_data: ~azure.mgmt.resource.deploymentscripts.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"kind": {"required": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"identity": {"key": "identity", "type": "ManagedServiceIdentity"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"kind": {"key": "kind", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
_subtype_map = {"kind": {"AzureCLI": "AzureCliScript", "AzurePowerShell": "AzurePowerShellScript"}}
def __init__(
self,
*,
location: str,
identity: Optional["_models.ManagedServiceIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs: Any
) -> None:
"""
:keyword identity: Optional property. Managed identity to be used for this deployment script.
Currently, only user-assigned MSI is supported.
:paramtype identity: ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentity
:keyword location: The location of the ACI and the storage account for the deployment script.
Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.identity = identity
self.location = location
self.tags = tags
self.kind: Optional[str] = None
self.system_data: Optional["_models.SystemData"] = None
class AzureCliScript(DeploymentScript):
"""Object model for the Azure CLI script.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar id: String Id used to locate any resource on Azure.
:vartype id: str
:ivar name: Name of this resource.
:vartype name: str
:ivar type: Type of this resource.
:vartype type: str
:ivar identity: Optional property. Managed identity to be used for this deployment script.
Currently, only user-assigned MSI is supported.
:vartype identity: ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentity
:ivar location: The location of the ACI and the storage account for the deployment script.
Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar kind: Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".
:vartype kind: str or ~azure.mgmt.resource.deploymentscripts.models.ScriptType
:ivar system_data: The system metadata related to this resource.
:vartype system_data: ~azure.mgmt.resource.deploymentscripts.models.SystemData
:ivar container_settings: Container settings.
:vartype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:ivar storage_account_settings: Storage Account settings.
:vartype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:ivar cleanup_preference: The clean up preference when the script execution gets in a terminal
state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:vartype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:ivar provisioning_state: State of the script execution. This only appears in the response.
Known values are: "Creating", "ProvisioningResources", "Running", "Succeeded", "Failed", and
"Canceled".
:vartype provisioning_state: str or
~azure.mgmt.resource.deploymentscripts.models.ScriptProvisioningState
:ivar status: Contains the results of script execution.
:vartype status: ~azure.mgmt.resource.deploymentscripts.models.ScriptStatus
:ivar outputs: List of script outputs.
:vartype outputs: dict[str, JSON]
:ivar primary_script_uri: Uri for the script. This is the entry point for the external script.
:vartype primary_script_uri: str
:ivar supporting_script_uris: Supporting files for the external script.
:vartype supporting_script_uris: list[str]
:ivar script_content: Script body.
:vartype script_content: str
:ivar arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:vartype arguments: str
:ivar environment_variables: The environment variables to pass over to the script.
:vartype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:ivar force_update_tag: Gets or sets how the deployment script should be forced to execute even
if the script resource has not changed. Can be current time stamp or a GUID.
:vartype force_update_tag: str
:ivar retention_interval: Interval for which the service retains the script resource after it
reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:vartype retention_interval: ~datetime.timedelta
:ivar timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:vartype timeout: ~datetime.timedelta
:ivar az_cli_version: Azure CLI module version to be used. Required.
:vartype az_cli_version: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"kind": {"required": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
"status": {"readonly": True},
"outputs": {"readonly": True},
"retention_interval": {"required": True},
"az_cli_version": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"identity": {"key": "identity", "type": "ManagedServiceIdentity"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"kind": {"key": "kind", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"container_settings": {"key": "properties.containerSettings", "type": "ContainerConfiguration"},
"storage_account_settings": {"key": "properties.storageAccountSettings", "type": "StorageAccountConfiguration"},
"cleanup_preference": {"key": "properties.cleanupPreference", "type": "str"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"status": {"key": "properties.status", "type": "ScriptStatus"},
"outputs": {"key": "properties.outputs", "type": "{object}"},
"primary_script_uri": {"key": "properties.primaryScriptUri", "type": "str"},
"supporting_script_uris": {"key": "properties.supportingScriptUris", "type": "[str]"},
"script_content": {"key": "properties.scriptContent", "type": "str"},
"arguments": {"key": "properties.arguments", "type": "str"},
"environment_variables": {"key": "properties.environmentVariables", "type": "[EnvironmentVariable]"},
"force_update_tag": {"key": "properties.forceUpdateTag", "type": "str"},
"retention_interval": {"key": "properties.retentionInterval", "type": "duration"},
"timeout": {"key": "properties.timeout", "type": "duration"},
"az_cli_version": {"key": "properties.azCliVersion", "type": "str"},
}
def __init__(
self,
*,
location: str,
retention_interval: datetime.timedelta,
az_cli_version: str,
identity: Optional["_models.ManagedServiceIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
container_settings: Optional["_models.ContainerConfiguration"] = None,
storage_account_settings: Optional["_models.StorageAccountConfiguration"] = None,
cleanup_preference: Union[str, "_models.CleanupOptions"] = "Always",
primary_script_uri: Optional[str] = None,
supporting_script_uris: Optional[List[str]] = None,
script_content: Optional[str] = None,
arguments: Optional[str] = None,
environment_variables: Optional[List["_models.EnvironmentVariable"]] = None,
force_update_tag: Optional[str] = None,
timeout: datetime.timedelta = "P1D",
**kwargs: Any
) -> None:
"""
:keyword identity: Optional property. Managed identity to be used for this deployment script.
Currently, only user-assigned MSI is supported.
:paramtype identity: ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentity
:keyword location: The location of the ACI and the storage account for the deployment script.
Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword container_settings: Container settings.
:paramtype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:keyword storage_account_settings: Storage Account settings.
:paramtype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:keyword cleanup_preference: The clean up preference when the script execution gets in a
terminal state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:paramtype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:keyword primary_script_uri: Uri for the script. This is the entry point for the external
script.
:paramtype primary_script_uri: str
:keyword supporting_script_uris: Supporting files for the external script.
:paramtype supporting_script_uris: list[str]
:keyword script_content: Script body.
:paramtype script_content: str
:keyword arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:paramtype arguments: str
:keyword environment_variables: The environment variables to pass over to the script.
:paramtype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:keyword force_update_tag: Gets or sets how the deployment script should be forced to execute
even if the script resource has not changed. Can be current time stamp or a GUID.
:paramtype force_update_tag: str
:keyword retention_interval: Interval for which the service retains the script resource after
it reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:paramtype retention_interval: ~datetime.timedelta
:keyword timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:paramtype timeout: ~datetime.timedelta
:keyword az_cli_version: Azure CLI module version to be used. Required.
:paramtype az_cli_version: str
"""
super().__init__(identity=identity, location=location, tags=tags, **kwargs)
self.kind: str = "AzureCLI"
self.container_settings = container_settings
self.storage_account_settings = storage_account_settings
self.cleanup_preference = cleanup_preference
self.provisioning_state: Optional[Union[str, "_models.ScriptProvisioningState"]] = None
self.status: Optional["_models.ScriptStatus"] = None
self.outputs: Optional[Dict[str, JSON]] = None
self.primary_script_uri = primary_script_uri
self.supporting_script_uris = supporting_script_uris
self.script_content = script_content
self.arguments = arguments
self.environment_variables = environment_variables
self.force_update_tag = force_update_tag
self.retention_interval = retention_interval
self.timeout = timeout
self.az_cli_version = az_cli_version
class ScriptConfigurationBase(_serialization.Model):
"""Common configuration settings for both Azure PowerShell and Azure CLI scripts.
All required parameters must be populated in order to send to server.
:ivar primary_script_uri: Uri for the script. This is the entry point for the external script.
:vartype primary_script_uri: str
:ivar supporting_script_uris: Supporting files for the external script.
:vartype supporting_script_uris: list[str]
:ivar script_content: Script body.
:vartype script_content: str
:ivar arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:vartype arguments: str
:ivar environment_variables: The environment variables to pass over to the script.
:vartype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:ivar force_update_tag: Gets or sets how the deployment script should be forced to execute even
if the script resource has not changed. Can be current time stamp or a GUID.
:vartype force_update_tag: str
:ivar retention_interval: Interval for which the service retains the script resource after it
reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:vartype retention_interval: ~datetime.timedelta
:ivar timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:vartype timeout: ~datetime.timedelta
"""
_validation = {
"retention_interval": {"required": True},
}
_attribute_map = {
"primary_script_uri": {"key": "primaryScriptUri", "type": "str"},
"supporting_script_uris": {"key": "supportingScriptUris", "type": "[str]"},
"script_content": {"key": "scriptContent", "type": "str"},
"arguments": {"key": "arguments", "type": "str"},
"environment_variables": {"key": "environmentVariables", "type": "[EnvironmentVariable]"},
"force_update_tag": {"key": "forceUpdateTag", "type": "str"},
"retention_interval": {"key": "retentionInterval", "type": "duration"},
"timeout": {"key": "timeout", "type": "duration"},
}
def __init__(
self,
*,
retention_interval: datetime.timedelta,
primary_script_uri: Optional[str] = None,
supporting_script_uris: Optional[List[str]] = None,
script_content: Optional[str] = None,
arguments: Optional[str] = None,
environment_variables: Optional[List["_models.EnvironmentVariable"]] = None,
force_update_tag: Optional[str] = None,
timeout: datetime.timedelta = "P1D",
**kwargs: Any
) -> None:
"""
:keyword primary_script_uri: Uri for the script. This is the entry point for the external
script.
:paramtype primary_script_uri: str
:keyword supporting_script_uris: Supporting files for the external script.
:paramtype supporting_script_uris: list[str]
:keyword script_content: Script body.
:paramtype script_content: str
:keyword arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:paramtype arguments: str
:keyword environment_variables: The environment variables to pass over to the script.
:paramtype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:keyword force_update_tag: Gets or sets how the deployment script should be forced to execute
even if the script resource has not changed. Can be current time stamp or a GUID.
:paramtype force_update_tag: str
:keyword retention_interval: Interval for which the service retains the script resource after
it reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:paramtype retention_interval: ~datetime.timedelta
:keyword timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:paramtype timeout: ~datetime.timedelta
"""
super().__init__(**kwargs)
self.primary_script_uri = primary_script_uri
self.supporting_script_uris = supporting_script_uris
self.script_content = script_content
self.arguments = arguments
self.environment_variables = environment_variables
self.force_update_tag = force_update_tag
self.retention_interval = retention_interval
self.timeout = timeout
class DeploymentScriptPropertiesBase(_serialization.Model):
"""Common properties for the deployment script.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar container_settings: Container settings.
:vartype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:ivar storage_account_settings: Storage Account settings.
:vartype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:ivar cleanup_preference: The clean up preference when the script execution gets in a terminal
state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:vartype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:ivar provisioning_state: State of the script execution. This only appears in the response.
Known values are: "Creating", "ProvisioningResources", "Running", "Succeeded", "Failed", and
"Canceled".
:vartype provisioning_state: str or
~azure.mgmt.resource.deploymentscripts.models.ScriptProvisioningState
:ivar status: Contains the results of script execution.
:vartype status: ~azure.mgmt.resource.deploymentscripts.models.ScriptStatus
:ivar outputs: List of script outputs.
:vartype outputs: dict[str, JSON]
"""
_validation = {
"provisioning_state": {"readonly": True},
"status": {"readonly": True},
"outputs": {"readonly": True},
}
_attribute_map = {
"container_settings": {"key": "containerSettings", "type": "ContainerConfiguration"},
"storage_account_settings": {"key": "storageAccountSettings", "type": "StorageAccountConfiguration"},
"cleanup_preference": {"key": "cleanupPreference", "type": "str"},
"provisioning_state": {"key": "provisioningState", "type": "str"},
"status": {"key": "status", "type": "ScriptStatus"},
"outputs": {"key": "outputs", "type": "{object}"},
}
def __init__(
self,
*,
container_settings: Optional["_models.ContainerConfiguration"] = None,
storage_account_settings: Optional["_models.StorageAccountConfiguration"] = None,
cleanup_preference: Union[str, "_models.CleanupOptions"] = "Always",
**kwargs: Any
) -> None:
"""
:keyword container_settings: Container settings.
:paramtype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:keyword storage_account_settings: Storage Account settings.
:paramtype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:keyword cleanup_preference: The clean up preference when the script execution gets in a
terminal state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:paramtype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
"""
super().__init__(**kwargs)
self.container_settings = container_settings
self.storage_account_settings = storage_account_settings
self.cleanup_preference = cleanup_preference
self.provisioning_state: Optional[Union[str, "_models.ScriptProvisioningState"]] = None
self.status: Optional["_models.ScriptStatus"] = None
self.outputs: Optional[Dict[str, JSON]] = None
class AzureCliScriptProperties(DeploymentScriptPropertiesBase, ScriptConfigurationBase):
"""Properties of the Azure CLI script object.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar primary_script_uri: Uri for the script. This is the entry point for the external script.
:vartype primary_script_uri: str
:ivar supporting_script_uris: Supporting files for the external script.
:vartype supporting_script_uris: list[str]
:ivar script_content: Script body.
:vartype script_content: str
:ivar arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:vartype arguments: str
:ivar environment_variables: The environment variables to pass over to the script.
:vartype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:ivar force_update_tag: Gets or sets how the deployment script should be forced to execute even
if the script resource has not changed. Can be current time stamp or a GUID.
:vartype force_update_tag: str
:ivar retention_interval: Interval for which the service retains the script resource after it
reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:vartype retention_interval: ~datetime.timedelta
:ivar timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:vartype timeout: ~datetime.timedelta
:ivar container_settings: Container settings.
:vartype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:ivar storage_account_settings: Storage Account settings.
:vartype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:ivar cleanup_preference: The clean up preference when the script execution gets in a terminal
state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:vartype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:ivar provisioning_state: State of the script execution. This only appears in the response.
Known values are: "Creating", "ProvisioningResources", "Running", "Succeeded", "Failed", and
"Canceled".
:vartype provisioning_state: str or
~azure.mgmt.resource.deploymentscripts.models.ScriptProvisioningState
:ivar status: Contains the results of script execution.
:vartype status: ~azure.mgmt.resource.deploymentscripts.models.ScriptStatus
:ivar outputs: List of script outputs.
:vartype outputs: dict[str, JSON]
:ivar az_cli_version: Azure CLI module version to be used. Required.
:vartype az_cli_version: str
"""
_validation = {
"retention_interval": {"required": True},
"provisioning_state": {"readonly": True},
"status": {"readonly": True},
"outputs": {"readonly": True},
"az_cli_version": {"required": True},
}
_attribute_map = {
"primary_script_uri": {"key": "primaryScriptUri", "type": "str"},
"supporting_script_uris": {"key": "supportingScriptUris", "type": "[str]"},
"script_content": {"key": "scriptContent", "type": "str"},
"arguments": {"key": "arguments", "type": "str"},
"environment_variables": {"key": "environmentVariables", "type": "[EnvironmentVariable]"},
"force_update_tag": {"key": "forceUpdateTag", "type": "str"},
"retention_interval": {"key": "retentionInterval", "type": "duration"},
"timeout": {"key": "timeout", "type": "duration"},
"container_settings": {"key": "containerSettings", "type": "ContainerConfiguration"},
"storage_account_settings": {"key": "storageAccountSettings", "type": "StorageAccountConfiguration"},
"cleanup_preference": {"key": "cleanupPreference", "type": "str"},
"provisioning_state": {"key": "provisioningState", "type": "str"},
"status": {"key": "status", "type": "ScriptStatus"},
"outputs": {"key": "outputs", "type": "{object}"},
"az_cli_version": {"key": "azCliVersion", "type": "str"},
}
def __init__(
self,
*,
retention_interval: datetime.timedelta,
az_cli_version: str,
primary_script_uri: Optional[str] = None,
supporting_script_uris: Optional[List[str]] = None,
script_content: Optional[str] = None,
arguments: Optional[str] = None,
environment_variables: Optional[List["_models.EnvironmentVariable"]] = None,
force_update_tag: Optional[str] = None,
timeout: datetime.timedelta = "P1D",
container_settings: Optional["_models.ContainerConfiguration"] = None,
storage_account_settings: Optional["_models.StorageAccountConfiguration"] = None,
cleanup_preference: Union[str, "_models.CleanupOptions"] = "Always",
**kwargs: Any
) -> None:
"""
:keyword primary_script_uri: Uri for the script. This is the entry point for the external
script.
:paramtype primary_script_uri: str
:keyword supporting_script_uris: Supporting files for the external script.
:paramtype supporting_script_uris: list[str]
:keyword script_content: Script body.
:paramtype script_content: str
:keyword arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:paramtype arguments: str
:keyword environment_variables: The environment variables to pass over to the script.
:paramtype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:keyword force_update_tag: Gets or sets how the deployment script should be forced to execute
even if the script resource has not changed. Can be current time stamp or a GUID.
:paramtype force_update_tag: str
:keyword retention_interval: Interval for which the service retains the script resource after
it reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:paramtype retention_interval: ~datetime.timedelta
:keyword timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:paramtype timeout: ~datetime.timedelta
:keyword container_settings: Container settings.
:paramtype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:keyword storage_account_settings: Storage Account settings.
:paramtype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:keyword cleanup_preference: The clean up preference when the script execution gets in a
terminal state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:paramtype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:keyword az_cli_version: Azure CLI module version to be used. Required.
:paramtype az_cli_version: str
"""
super().__init__(
container_settings=container_settings,
storage_account_settings=storage_account_settings,
cleanup_preference=cleanup_preference,
primary_script_uri=primary_script_uri,
supporting_script_uris=supporting_script_uris,
script_content=script_content,
arguments=arguments,
environment_variables=environment_variables,
force_update_tag=force_update_tag,
retention_interval=retention_interval,
timeout=timeout,
**kwargs
)
self.primary_script_uri = primary_script_uri
self.supporting_script_uris = supporting_script_uris
self.script_content = script_content
self.arguments = arguments
self.environment_variables = environment_variables
self.force_update_tag = force_update_tag
self.retention_interval = retention_interval
self.timeout = timeout
self.az_cli_version = az_cli_version
self.container_settings = container_settings
self.storage_account_settings = storage_account_settings
self.cleanup_preference = cleanup_preference
self.provisioning_state: Optional[Union[str, "_models.ScriptProvisioningState"]] = None
self.status: Optional["_models.ScriptStatus"] = None
self.outputs: Optional[Dict[str, JSON]] = None
class AzurePowerShellScript(DeploymentScript):
"""Object model for the Azure PowerShell script.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar id: String Id used to locate any resource on Azure.
:vartype id: str
:ivar name: Name of this resource.
:vartype name: str
:ivar type: Type of this resource.
:vartype type: str
:ivar identity: Optional property. Managed identity to be used for this deployment script.
Currently, only user-assigned MSI is supported.
:vartype identity: ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentity
:ivar location: The location of the ACI and the storage account for the deployment script.
Required.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar kind: Type of the script. Required. Known values are: "AzurePowerShell" and "AzureCLI".
:vartype kind: str or ~azure.mgmt.resource.deploymentscripts.models.ScriptType
:ivar system_data: The system metadata related to this resource.
:vartype system_data: ~azure.mgmt.resource.deploymentscripts.models.SystemData
:ivar container_settings: Container settings.
:vartype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:ivar storage_account_settings: Storage Account settings.
:vartype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:ivar cleanup_preference: The clean up preference when the script execution gets in a terminal
state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:vartype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:ivar provisioning_state: State of the script execution. This only appears in the response.
Known values are: "Creating", "ProvisioningResources", "Running", "Succeeded", "Failed", and
"Canceled".
:vartype provisioning_state: str or
~azure.mgmt.resource.deploymentscripts.models.ScriptProvisioningState
:ivar status: Contains the results of script execution.
:vartype status: ~azure.mgmt.resource.deploymentscripts.models.ScriptStatus
:ivar outputs: List of script outputs.
:vartype outputs: dict[str, JSON]
:ivar primary_script_uri: Uri for the script. This is the entry point for the external script.
:vartype primary_script_uri: str
:ivar supporting_script_uris: Supporting files for the external script.
:vartype supporting_script_uris: list[str]
:ivar script_content: Script body.
:vartype script_content: str
:ivar arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:vartype arguments: str
:ivar environment_variables: The environment variables to pass over to the script.
:vartype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:ivar force_update_tag: Gets or sets how the deployment script should be forced to execute even
if the script resource has not changed. Can be current time stamp or a GUID.
:vartype force_update_tag: str
:ivar retention_interval: Interval for which the service retains the script resource after it
reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:vartype retention_interval: ~datetime.timedelta
:ivar timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:vartype timeout: ~datetime.timedelta
:ivar az_power_shell_version: Azure PowerShell module version to be used. Required.
:vartype az_power_shell_version: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"required": True},
"kind": {"required": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
"status": {"readonly": True},
"outputs": {"readonly": True},
"retention_interval": {"required": True},
"az_power_shell_version": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"identity": {"key": "identity", "type": "ManagedServiceIdentity"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"kind": {"key": "kind", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"container_settings": {"key": "properties.containerSettings", "type": "ContainerConfiguration"},
"storage_account_settings": {"key": "properties.storageAccountSettings", "type": "StorageAccountConfiguration"},
"cleanup_preference": {"key": "properties.cleanupPreference", "type": "str"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"status": {"key": "properties.status", "type": "ScriptStatus"},
"outputs": {"key": "properties.outputs", "type": "{object}"},
"primary_script_uri": {"key": "properties.primaryScriptUri", "type": "str"},
"supporting_script_uris": {"key": "properties.supportingScriptUris", "type": "[str]"},
"script_content": {"key": "properties.scriptContent", "type": "str"},
"arguments": {"key": "properties.arguments", "type": "str"},
"environment_variables": {"key": "properties.environmentVariables", "type": "[EnvironmentVariable]"},
"force_update_tag": {"key": "properties.forceUpdateTag", "type": "str"},
"retention_interval": {"key": "properties.retentionInterval", "type": "duration"},
"timeout": {"key": "properties.timeout", "type": "duration"},
"az_power_shell_version": {"key": "properties.azPowerShellVersion", "type": "str"},
}
def __init__(
self,
*,
location: str,
retention_interval: datetime.timedelta,
az_power_shell_version: str,
identity: Optional["_models.ManagedServiceIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
container_settings: Optional["_models.ContainerConfiguration"] = None,
storage_account_settings: Optional["_models.StorageAccountConfiguration"] = None,
cleanup_preference: Union[str, "_models.CleanupOptions"] = "Always",
primary_script_uri: Optional[str] = None,
supporting_script_uris: Optional[List[str]] = None,
script_content: Optional[str] = None,
arguments: Optional[str] = None,
environment_variables: Optional[List["_models.EnvironmentVariable"]] = None,
force_update_tag: Optional[str] = None,
timeout: datetime.timedelta = "P1D",
**kwargs: Any
) -> None:
"""
:keyword identity: Optional property. Managed identity to be used for this deployment script.
Currently, only user-assigned MSI is supported.
:paramtype identity: ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentity
:keyword location: The location of the ACI and the storage account for the deployment script.
Required.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword container_settings: Container settings.
:paramtype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:keyword storage_account_settings: Storage Account settings.
:paramtype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:keyword cleanup_preference: The clean up preference when the script execution gets in a
terminal state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:paramtype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:keyword primary_script_uri: Uri for the script. This is the entry point for the external
script.
:paramtype primary_script_uri: str
:keyword supporting_script_uris: Supporting files for the external script.
:paramtype supporting_script_uris: list[str]
:keyword script_content: Script body.
:paramtype script_content: str
:keyword arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:paramtype arguments: str
:keyword environment_variables: The environment variables to pass over to the script.
:paramtype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:keyword force_update_tag: Gets or sets how the deployment script should be forced to execute
even if the script resource has not changed. Can be current time stamp or a GUID.
:paramtype force_update_tag: str
:keyword retention_interval: Interval for which the service retains the script resource after
it reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:paramtype retention_interval: ~datetime.timedelta
:keyword timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:paramtype timeout: ~datetime.timedelta
:keyword az_power_shell_version: Azure PowerShell module version to be used. Required.
:paramtype az_power_shell_version: str
"""
super().__init__(identity=identity, location=location, tags=tags, **kwargs)
self.kind: str = "AzurePowerShell"
self.container_settings = container_settings
self.storage_account_settings = storage_account_settings
self.cleanup_preference = cleanup_preference
self.provisioning_state: Optional[Union[str, "_models.ScriptProvisioningState"]] = None
self.status: Optional["_models.ScriptStatus"] = None
self.outputs: Optional[Dict[str, JSON]] = None
self.primary_script_uri = primary_script_uri
self.supporting_script_uris = supporting_script_uris
self.script_content = script_content
self.arguments = arguments
self.environment_variables = environment_variables
self.force_update_tag = force_update_tag
self.retention_interval = retention_interval
self.timeout = timeout
self.az_power_shell_version = az_power_shell_version
class AzurePowerShellScriptProperties(DeploymentScriptPropertiesBase, ScriptConfigurationBase):
"""Properties of the Azure PowerShell script object.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
:ivar primary_script_uri: Uri for the script. This is the entry point for the external script.
:vartype primary_script_uri: str
:ivar supporting_script_uris: Supporting files for the external script.
:vartype supporting_script_uris: list[str]
:ivar script_content: Script body.
:vartype script_content: str
:ivar arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:vartype arguments: str
:ivar environment_variables: The environment variables to pass over to the script.
:vartype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:ivar force_update_tag: Gets or sets how the deployment script should be forced to execute even
if the script resource has not changed. Can be current time stamp or a GUID.
:vartype force_update_tag: str
:ivar retention_interval: Interval for which the service retains the script resource after it
reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:vartype retention_interval: ~datetime.timedelta
:ivar timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:vartype timeout: ~datetime.timedelta
:ivar container_settings: Container settings.
:vartype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:ivar storage_account_settings: Storage Account settings.
:vartype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:ivar cleanup_preference: The clean up preference when the script execution gets in a terminal
state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:vartype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:ivar provisioning_state: State of the script execution. This only appears in the response.
Known values are: "Creating", "ProvisioningResources", "Running", "Succeeded", "Failed", and
"Canceled".
:vartype provisioning_state: str or
~azure.mgmt.resource.deploymentscripts.models.ScriptProvisioningState
:ivar status: Contains the results of script execution.
:vartype status: ~azure.mgmt.resource.deploymentscripts.models.ScriptStatus
:ivar outputs: List of script outputs.
:vartype outputs: dict[str, JSON]
:ivar az_power_shell_version: Azure PowerShell module version to be used. Required.
:vartype az_power_shell_version: str
"""
_validation = {
"retention_interval": {"required": True},
"provisioning_state": {"readonly": True},
"status": {"readonly": True},
"outputs": {"readonly": True},
"az_power_shell_version": {"required": True},
}
_attribute_map = {
"primary_script_uri": {"key": "primaryScriptUri", "type": "str"},
"supporting_script_uris": {"key": "supportingScriptUris", "type": "[str]"},
"script_content": {"key": "scriptContent", "type": "str"},
"arguments": {"key": "arguments", "type": "str"},
"environment_variables": {"key": "environmentVariables", "type": "[EnvironmentVariable]"},
"force_update_tag": {"key": "forceUpdateTag", "type": "str"},
"retention_interval": {"key": "retentionInterval", "type": "duration"},
"timeout": {"key": "timeout", "type": "duration"},
"container_settings": {"key": "containerSettings", "type": "ContainerConfiguration"},
"storage_account_settings": {"key": "storageAccountSettings", "type": "StorageAccountConfiguration"},
"cleanup_preference": {"key": "cleanupPreference", "type": "str"},
"provisioning_state": {"key": "provisioningState", "type": "str"},
"status": {"key": "status", "type": "ScriptStatus"},
"outputs": {"key": "outputs", "type": "{object}"},
"az_power_shell_version": {"key": "azPowerShellVersion", "type": "str"},
}
def __init__(
self,
*,
retention_interval: datetime.timedelta,
az_power_shell_version: str,
primary_script_uri: Optional[str] = None,
supporting_script_uris: Optional[List[str]] = None,
script_content: Optional[str] = None,
arguments: Optional[str] = None,
environment_variables: Optional[List["_models.EnvironmentVariable"]] = None,
force_update_tag: Optional[str] = None,
timeout: datetime.timedelta = "P1D",
container_settings: Optional["_models.ContainerConfiguration"] = None,
storage_account_settings: Optional["_models.StorageAccountConfiguration"] = None,
cleanup_preference: Union[str, "_models.CleanupOptions"] = "Always",
**kwargs: Any
) -> None:
"""
:keyword primary_script_uri: Uri for the script. This is the entry point for the external
script.
:paramtype primary_script_uri: str
:keyword supporting_script_uris: Supporting files for the external script.
:paramtype supporting_script_uris: list[str]
:keyword script_content: Script body.
:paramtype script_content: str
:keyword arguments: Command line arguments to pass to the script. Arguments are separated by
spaces. ex: -Name blue* -Location 'West US 2'.
:paramtype arguments: str
:keyword environment_variables: The environment variables to pass over to the script.
:paramtype environment_variables:
list[~azure.mgmt.resource.deploymentscripts.models.EnvironmentVariable]
:keyword force_update_tag: Gets or sets how the deployment script should be forced to execute
even if the script resource has not changed. Can be current time stamp or a GUID.
:paramtype force_update_tag: str
:keyword retention_interval: Interval for which the service retains the script resource after
it reaches a terminal state. Resource will be deleted when this duration expires. Duration is
based on ISO 8601 pattern (for example P1D means one day). Required.
:paramtype retention_interval: ~datetime.timedelta
:keyword timeout: Maximum allowed script execution time specified in ISO 8601 format. Default
value is P1D.
:paramtype timeout: ~datetime.timedelta
:keyword container_settings: Container settings.
:paramtype container_settings:
~azure.mgmt.resource.deploymentscripts.models.ContainerConfiguration
:keyword storage_account_settings: Storage Account settings.
:paramtype storage_account_settings:
~azure.mgmt.resource.deploymentscripts.models.StorageAccountConfiguration
:keyword cleanup_preference: The clean up preference when the script execution gets in a
terminal state. Default setting is 'Always'. Known values are: "Always", "OnSuccess", and
"OnExpiration".
:paramtype cleanup_preference: str or
~azure.mgmt.resource.deploymentscripts.models.CleanupOptions
:keyword az_power_shell_version: Azure PowerShell module version to be used. Required.
:paramtype az_power_shell_version: str
"""
super().__init__(
container_settings=container_settings,
storage_account_settings=storage_account_settings,
cleanup_preference=cleanup_preference,
primary_script_uri=primary_script_uri,
supporting_script_uris=supporting_script_uris,
script_content=script_content,
arguments=arguments,
environment_variables=environment_variables,
force_update_tag=force_update_tag,
retention_interval=retention_interval,
timeout=timeout,
**kwargs
)
self.primary_script_uri = primary_script_uri
self.supporting_script_uris = supporting_script_uris
self.script_content = script_content
self.arguments = arguments
self.environment_variables = environment_variables
self.force_update_tag = force_update_tag
self.retention_interval = retention_interval
self.timeout = timeout
self.az_power_shell_version = az_power_shell_version
self.container_settings = container_settings
self.storage_account_settings = storage_account_settings
self.cleanup_preference = cleanup_preference
self.provisioning_state: Optional[Union[str, "_models.ScriptProvisioningState"]] = None
self.status: Optional["_models.ScriptStatus"] = None
self.outputs: Optional[Dict[str, JSON]] = None
class ContainerConfiguration(_serialization.Model):
"""Settings to customize ACI container instance.
:ivar container_group_name: Container group name, if not specified then the name will get
auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique
name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName'
when you have an Azure Policy that expects a specific naming convention or when you want to
fully control the name. 'containerGroupName' property must be between 1 and 63 characters long,
must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash
and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following
object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }.
If you do not want to specify a 'containerGroupName' then do not add 'containerSettings'
property.
:vartype container_group_name: str
"""
_validation = {
"container_group_name": {"max_length": 63, "min_length": 1},
}
_attribute_map = {
"container_group_name": {"key": "containerGroupName", "type": "str"},
}
def __init__(self, *, container_group_name: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword container_group_name: Container group name, if not specified then the name will get
auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique
name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName'
when you have an Azure Policy that expects a specific naming convention or when you want to
fully control the name. 'containerGroupName' property must be between 1 and 63 characters long,
must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash
and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following
object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }.
If you do not want to specify a 'containerGroupName' then do not add 'containerSettings'
property.
:paramtype container_group_name: str
"""
super().__init__(**kwargs)
self.container_group_name = container_group_name
class DeploymentScriptListResult(_serialization.Model):
"""List of deployment scripts.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: An array of deployment scripts.
:vartype value: list[~azure.mgmt.resource.deploymentscripts.models.DeploymentScript]
:ivar next_link: The URL to use for getting the next set of results.
:vartype next_link: str
"""
_validation = {
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[DeploymentScript]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, value: Optional[List["_models.DeploymentScript"]] = None, **kwargs: Any) -> None:
"""
:keyword value: An array of deployment scripts.
:paramtype value: list[~azure.mgmt.resource.deploymentscripts.models.DeploymentScript]
"""
super().__init__(**kwargs)
self.value = value
self.next_link: Optional[str] = None
class DeploymentScriptsError(_serialization.Model):
"""Deployment scripts error response.
:ivar error: Common error response for all Azure Resource Manager APIs to return error details
for failed operations. (This also follows the OData error response format.).
:vartype error: ~azure.mgmt.resource.deploymentscripts.models.ErrorResponse
"""
_attribute_map = {
"error": {"key": "error", "type": "ErrorResponse"},
}
def __init__(self, *, error: Optional["_models.ErrorResponse"] = None, **kwargs: Any) -> None:
"""
:keyword error: Common error response for all Azure Resource Manager APIs to return error
details for failed operations. (This also follows the OData error response format.).
:paramtype error: ~azure.mgmt.resource.deploymentscripts.models.ErrorResponse
"""
super().__init__(**kwargs)
self.error = error
class DeploymentScriptUpdateParameter(AzureResourceBase):
"""Deployment script parameters to be updated.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: String Id used to locate any resource on Azure.
:vartype id: str
:ivar name: Name of this resource.
:vartype name: str
:ivar type: Type of this resource.
:vartype type: str
:ivar tags: Resource tags to be updated.
:vartype tags: dict[str, str]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, *, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword tags: Resource tags to be updated.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.tags = tags
class EnvironmentVariable(_serialization.Model):
"""The environment variable to pass to the script in the container instance.
All required parameters must be populated in order to send to server.
:ivar name: The name of the environment variable. Required.
:vartype name: str
:ivar value: The value of the environment variable.
:vartype value: str
:ivar secure_value: The value of the secure environment variable.
:vartype secure_value: str
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"value": {"key": "value", "type": "str"},
"secure_value": {"key": "secureValue", "type": "str"},
}
def __init__(
self, *, name: str, value: Optional[str] = None, secure_value: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword name: The name of the environment variable. Required.
:paramtype name: str
:keyword value: The value of the environment variable.
:paramtype value: str
:keyword secure_value: The value of the secure environment variable.
:paramtype secure_value: str
"""
super().__init__(**kwargs)
self.name = name
self.value = value
self.secure_value = secure_value
class ErrorAdditionalInfo(_serialization.Model):
"""The resource management error additional info.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar type: The additional info type.
:vartype type: str
:ivar info: The additional info.
:vartype info: JSON
"""
_validation = {
"type": {"readonly": True},
"info": {"readonly": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"info": {"key": "info", "type": "object"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.type: Optional[str] = None
self.info: Optional[JSON] = None
class ErrorResponse(_serialization.Model):
"""Common error response for all Azure Resource Manager APIs to return error details for failed
operations. (This also follows the OData error response format.).
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: The error code.
:vartype code: str
:ivar message: The error message.
:vartype message: str
:ivar target: The error target.
:vartype target: str
:ivar details: The error details.
:vartype details: list[~azure.mgmt.resource.deploymentscripts.models.ErrorResponse]
:ivar additional_info: The error additional info.
:vartype additional_info:
list[~azure.mgmt.resource.deploymentscripts.models.ErrorAdditionalInfo]
"""
_validation = {
"code": {"readonly": True},
"message": {"readonly": True},
"target": {"readonly": True},
"details": {"readonly": True},
"additional_info": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"message": {"key": "message", "type": "str"},
"target": {"key": "target", "type": "str"},
"details": {"key": "details", "type": "[ErrorResponse]"},
"additional_info": {"key": "additionalInfo", "type": "[ErrorAdditionalInfo]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.code: Optional[str] = None
self.message: Optional[str] = None
self.target: Optional[str] = None
self.details: Optional[List["_models.ErrorResponse"]] = None
self.additional_info: Optional[List["_models.ErrorAdditionalInfo"]] = None
class ManagedServiceIdentity(_serialization.Model):
"""Managed identity generic object.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar type: Type of the managed identity. "UserAssigned"
:vartype type: str or ~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentityType
:ivar tenant_id: ID of the Azure Active Directory.
:vartype tenant_id: str
:ivar user_assigned_identities: The list of user-assigned managed identities associated with
the resource. Key is the Azure resource Id of the managed identity.
:vartype user_assigned_identities: dict[str,
~azure.mgmt.resource.deploymentscripts.models.UserAssignedIdentity]
"""
_validation = {
"tenant_id": {"readonly": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"user_assigned_identities": {"key": "userAssignedIdentities", "type": "{UserAssignedIdentity}"},
}
def __init__(
self,
*,
type: Optional[Union[str, "_models.ManagedServiceIdentityType"]] = None,
user_assigned_identities: Optional[Dict[str, "_models.UserAssignedIdentity"]] = None,
**kwargs: Any
) -> None:
"""
:keyword type: Type of the managed identity. "UserAssigned"
:paramtype type: str or
~azure.mgmt.resource.deploymentscripts.models.ManagedServiceIdentityType
:keyword user_assigned_identities: The list of user-assigned managed identities associated with
the resource. Key is the Azure resource Id of the managed identity.
:paramtype user_assigned_identities: dict[str,
~azure.mgmt.resource.deploymentscripts.models.UserAssignedIdentity]
"""
super().__init__(**kwargs)
self.type = type
self.tenant_id: Optional[str] = None
self.user_assigned_identities = user_assigned_identities
class ScriptLog(AzureResourceBase):
"""Script execution log object.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: String Id used to locate any resource on Azure.
:vartype id: str
:ivar name: Name of this resource.
:vartype name: str
:ivar type: Type of this resource.
:vartype type: str
:ivar log: Script execution logs in text format.
:vartype log: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"log": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"log": {"key": "properties.log", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.log: Optional[str] = None
class ScriptLogsList(_serialization.Model):
"""Deployment script execution logs.
:ivar value: Deployment scripts logs.
:vartype value: list[~azure.mgmt.resource.deploymentscripts.models.ScriptLog]
"""
_attribute_map = {
"value": {"key": "value", "type": "[ScriptLog]"},
}
def __init__(self, *, value: Optional[List["_models.ScriptLog"]] = None, **kwargs: Any) -> None:
"""
:keyword value: Deployment scripts logs.
:paramtype value: list[~azure.mgmt.resource.deploymentscripts.models.ScriptLog]
"""
super().__init__(**kwargs)
self.value = value
class ScriptStatus(_serialization.Model):
"""Generic object modeling results of script execution.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar container_instance_id: ACI resource Id.
:vartype container_instance_id: str
:ivar storage_account_id: Storage account resource Id.
:vartype storage_account_id: str
:ivar start_time: Start time of the script execution.
:vartype start_time: ~datetime.datetime
:ivar end_time: End time of the script execution.
:vartype end_time: ~datetime.datetime
:ivar expiration_time: Time the deployment script resource will expire.
:vartype expiration_time: ~datetime.datetime
:ivar error: Error that is relayed from the script execution.
:vartype error: ~azure.mgmt.resource.deploymentscripts.models.ErrorResponse
"""
_validation = {
"container_instance_id": {"readonly": True},
"storage_account_id": {"readonly": True},
"start_time": {"readonly": True},
"end_time": {"readonly": True},
"expiration_time": {"readonly": True},
}
_attribute_map = {
"container_instance_id": {"key": "containerInstanceId", "type": "str"},
"storage_account_id": {"key": "storageAccountId", "type": "str"},
"start_time": {"key": "startTime", "type": "iso-8601"},
"end_time": {"key": "endTime", "type": "iso-8601"},
"expiration_time": {"key": "expirationTime", "type": "iso-8601"},
"error": {"key": "error", "type": "ErrorResponse"},
}
def __init__(self, *, error: Optional["_models.ErrorResponse"] = None, **kwargs: Any) -> None:
"""
:keyword error: Error that is relayed from the script execution.
:paramtype error: ~azure.mgmt.resource.deploymentscripts.models.ErrorResponse
"""
super().__init__(**kwargs)
self.container_instance_id: Optional[str] = None
self.storage_account_id: Optional[str] = None
self.start_time: Optional[datetime.datetime] = None
self.end_time: Optional[datetime.datetime] = None
self.expiration_time: Optional[datetime.datetime] = None
self.error = error
class StorageAccountConfiguration(_serialization.Model):
"""Settings to use an existing storage account. Valid storage account kinds are: Storage,
StorageV2 and FileStorage.
:ivar storage_account_name: The storage account name.
:vartype storage_account_name: str
:ivar storage_account_key: The storage account access key.
:vartype storage_account_key: str
"""
_attribute_map = {
"storage_account_name": {"key": "storageAccountName", "type": "str"},
"storage_account_key": {"key": "storageAccountKey", "type": "str"},
}
def __init__(
self, *, storage_account_name: Optional[str] = None, storage_account_key: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword storage_account_name: The storage account name.
:paramtype storage_account_name: str
:keyword storage_account_key: The storage account access key.
:paramtype storage_account_key: str
"""
super().__init__(**kwargs)
self.storage_account_name = storage_account_name
self.storage_account_key = storage_account_key
class SystemData(_serialization.Model):
"""Metadata pertaining to creation and last modification of the resource.
:ivar created_by: The identity that created the resource.
:vartype created_by: str
:ivar created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:vartype created_by_type: str or ~azure.mgmt.resource.deploymentscripts.models.CreatedByType
:ivar created_at: The timestamp of resource creation (UTC).
:vartype created_at: ~datetime.datetime
:ivar last_modified_by: The identity that last modified the resource.
:vartype last_modified_by: str
:ivar last_modified_by_type: The type of identity that last modified the resource. Known values
are: "User", "Application", "ManagedIdentity", and "Key".
:vartype last_modified_by_type: str or
~azure.mgmt.resource.deploymentscripts.models.CreatedByType
:ivar last_modified_at: The timestamp of resource last modification (UTC).
:vartype last_modified_at: ~datetime.datetime
"""
_attribute_map = {
"created_by": {"key": "createdBy", "type": "str"},
"created_by_type": {"key": "createdByType", "type": "str"},
"created_at": {"key": "createdAt", "type": "iso-8601"},
"last_modified_by": {"key": "lastModifiedBy", "type": "str"},
"last_modified_by_type": {"key": "lastModifiedByType", "type": "str"},
"last_modified_at": {"key": "lastModifiedAt", "type": "iso-8601"},
}
def __init__(
self,
*,
created_by: Optional[str] = None,
created_by_type: Optional[Union[str, "_models.CreatedByType"]] = None,
created_at: Optional[datetime.datetime] = None,
last_modified_by: Optional[str] = None,
last_modified_by_type: Optional[Union[str, "_models.CreatedByType"]] = None,
last_modified_at: Optional[datetime.datetime] = None,
**kwargs: Any
) -> None:
"""
:keyword created_by: The identity that created the resource.
:paramtype created_by: str
:keyword created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:paramtype created_by_type: str or ~azure.mgmt.resource.deploymentscripts.models.CreatedByType
:keyword created_at: The timestamp of resource creation (UTC).
:paramtype created_at: ~datetime.datetime
:keyword last_modified_by: The identity that last modified the resource.
:paramtype last_modified_by: str
:keyword last_modified_by_type: The type of identity that last modified the resource. Known
values are: "User", "Application", "ManagedIdentity", and "Key".
:paramtype last_modified_by_type: str or
~azure.mgmt.resource.deploymentscripts.models.CreatedByType
:keyword last_modified_at: The timestamp of resource last modification (UTC).
:paramtype last_modified_at: ~datetime.datetime
"""
super().__init__(**kwargs)
self.created_by = created_by
self.created_by_type = created_by_type
self.created_at = created_at
self.last_modified_by = last_modified_by
self.last_modified_by_type = last_modified_by_type
self.last_modified_at = last_modified_at
class UserAssignedIdentity(_serialization.Model):
"""User-assigned managed identity.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: Azure Active Directory principal ID associated with this identity.
:vartype principal_id: str
:ivar client_id: Client App Id associated with this identity.
:vartype client_id: str
"""
_validation = {
"principal_id": {"readonly": True},
"client_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"client_id": {"key": "clientId", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.principal_id: Optional[str] = None
self.client_id: Optional[str] = None
|