**Basic**"
+ },
+ "capacity": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the number of virtual machines in the scale set."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Plan",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The plan ID."
+ },
+ "publisher": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The publisher ID."
+ },
+ "product": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element."
+ },
+ "promotionCode": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The promotion code."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetProperties",
+ "properties": {
+ "upgradePolicy": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The upgrade policy."
+ },
+ "scheduledEventsPolicy": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "The ScheduledEventsPolicy."
+ },
+ "automaticRepairsPolicy": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 0,
+ "description": "Policy for automatic repairs."
+ },
+ "virtualMachineProfile": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "The virtual machine profile."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "overprovision": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned."
+ },
+ "doNotRunExtensionsOnOverprovisionedVMs": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs."
+ },
+ "uniqueId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set."
+ },
+ "singlePlacementGroup": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true."
+ },
+ "zoneBalance": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set."
+ },
+ "platformFaultDomainCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Fault Domain count for each placement group."
+ },
+ "proximityPlacementGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01."
+ },
+ "hostGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01."
+ },
+ "additionalCapabilities": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 0,
+ "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type."
+ },
+ "scaleInPolicy": {
+ "type": {
+ "$ref": "#/240"
+ },
+ "flags": 0,
+ "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set."
+ },
+ "orchestrationMode": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "Specifies the orchestration mode for the virtual machine scale set."
+ },
+ "spotRestorePolicy": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Specifies the Spot Restore properties for the virtual machine scale set."
+ },
+ "priorityMixPolicy": {
+ "type": {
+ "$ref": "#/250"
+ },
+ "flags": 0,
+ "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance."
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01."
+ },
+ "constrainedMaximumCapacity": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Optional property which must either be set to True or omitted."
+ },
+ "resiliencyPolicy": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "Policy for Resiliency"
+ },
+ "zonalPlatformFaultDomainAlignMode": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 0,
+ "description": "Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count."
+ },
+ "skuProfile": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 0,
+ "description": "Specifies the sku profile for the virtual machine scale set."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpgradePolicy",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Specifies the mode of an upgrade to virtual machines in the scale set.
Possible values are:
**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.
**Automatic** - All virtual machines in the scale set are automatically updated at the same time."
+ },
+ "rollingUpgradePolicy": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while performing a rolling upgrade."
+ },
+ "automaticOSUpgradePolicy": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "Configuration parameters used for performing automatic OS Upgrade."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Automatic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Manual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rolling"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RollingUpgradePolicy",
+ "properties": {
+ "maxBatchInstancePercent": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%."
+ },
+ "maxUnhealthyInstancePercent": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%."
+ },
+ "maxUnhealthyUpgradedInstancePercent": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%."
+ },
+ "pauseTimeBetweenBatches": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)."
+ },
+ "enableCrossZoneUpgrade": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size."
+ },
+ "prioritizeUnhealthyInstances": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Upgrade all unhealthy instances in a scale set before any healthy instances."
+ },
+ "rollbackFailedInstancesOnPolicyBreach": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated."
+ },
+ "maxSurge": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 5,
+ "maxValue": 100
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 100
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutomaticOSUpgradePolicy",
+ "properties": {
+ "enableAutomaticOSUpgrade": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true."
+ },
+ "disableAutomaticRollback": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether OS image rollback feature should be disabled. Default value is false."
+ },
+ "useRollingUpgradePolicy": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS."
+ },
+ "osRollingUpgradeDeferral": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduledEventsPolicy",
+ "properties": {
+ "userInitiatedRedeploy": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation."
+ },
+ "userInitiatedReboot": {
+ "type": {
+ "$ref": "#/20"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while creating userInitiatedReboot scheduled event setting creation."
+ },
+ "scheduledEventsAdditionalPublishingTargets": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserInitiatedRedeploy",
+ "properties": {
+ "automaticallyApprove": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies Redeploy Scheduled Event related configurations."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserInitiatedReboot",
+ "properties": {
+ "automaticallyApprove": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies Reboot Scheduled Event related configurations."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduledEventsAdditionalPublishingTargets",
+ "properties": {
+ "eventGridAndResourceGraph": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventGridAndResourceGraph",
+ "properties": {
+ "enable": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies if event grid and resource graph is enabled for Scheduled event related configurations."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutomaticRepairsPolicy",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false."
+ },
+ "gracePeriod": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)."
+ },
+ "repairAction": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replace"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restart"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Reimage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/26"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMProfile",
+ "properties": {
+ "osProfile": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Specifies the operating system settings for the virtual machines in the scale set."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 0,
+ "description": "Specifies properties of the network interfaces of the virtual machines in the scale set."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Specifies the Security related profile settings for the virtual machines in the scale set."
+ },
+ "diagnosticsProfile": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 0,
+ "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15."
+ },
+ "extensionProfile": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set."
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies that the image or disk that is being used was licensed on-premises.
Possible values for Windows Server operating system are:
Windows_Client
Windows_Server
Possible values for Linux Server operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS (for SUSE)
For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
Minimum api-version: 2015-06-15"
+ },
+ "priority": {
+ "type": {
+ "$ref": "#/222"
+ },
+ "flags": 0,
+ "description": "Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview."
+ },
+ "evictionPolicy": {
+ "type": {
+ "$ref": "#/225"
+ },
+ "flags": 0,
+ "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
+ },
+ "billingProfile": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01."
+ },
+ "scheduledEventsProfile": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "Specifies Scheduled Event related configurations."
+ },
+ "userData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01."
+ },
+ "capacityReservation": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 0,
+ "description": "Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01."
+ },
+ "applicationProfile": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Specifies the gallery applications that should be made available to the VM/VMSS"
+ },
+ "hardwareProfile": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 0,
+ "description": "Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01."
+ },
+ "serviceArtifactReference": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01"
+ },
+ "securityPostureReference": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01"
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetOSProfile",
+ "properties": {
+ "computerNamePrefix": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long."
+ },
+ "adminUsername": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the name of the administrator account.
**Max-length (Windows):** 20 characters"
+ },
+ "adminPassword": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)"
+ },
+ "customData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)"
+ },
+ "windowsConfiguration": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "Specifies Windows operating system settings on the virtual machine."
+ },
+ "linuxConfiguration": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
+ },
+ "secrets": {
+ "type": {
+ "$ref": "#/80"
+ },
+ "flags": 0,
+ "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ },
+ "allowExtensionOperations": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set."
+ },
+ "requireGuestProvisionSignal": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Optional property which must either be set to True or omitted."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsConfiguration",
+ "properties": {
+ "provisionVMAgent": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later."
+ },
+ "enableAutomaticUpdates": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning."
+ },
+ "timeZone": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)."
+ },
+ "additionalUnattendContent": {
+ "type": {
+ "$ref": "#/38"
+ },
+ "flags": 0,
+ "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup."
+ },
+ "patchSettings": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows."
+ },
+ "winRM": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell."
+ },
+ "enableVMAgentPlatformUpdates": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdditionalUnattendContent",
+ "properties": {
+ "passName": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "The pass name. Currently, the only allowable value is OobeSystem."
+ },
+ "componentName": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 0,
+ "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup."
+ },
+ "settingName": {
+ "type": {
+ "$ref": "#/37"
+ },
+ "flags": 0,
+ "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon."
+ },
+ "content": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OobeSystem"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft-Windows-Shell-Setup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutoLogon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FirstLogonCommands"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/36"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/32"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PatchSettings",
+ "properties": {
+ "patchMode": {
+ "type": {
+ "$ref": "#/43"
+ },
+ "flags": 0,
+ "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false
**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.
**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true"
+ },
+ "enableHotpatching": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'."
+ },
+ "assessmentMode": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
Possible values are:
**ImageDefault** - You control the timing of patch assessments on a virtual machine.
**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true."
+ },
+ "automaticByPlatformSettings": {
+ "type": {
+ "$ref": "#/47"
+ },
+ "flags": 0,
+ "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Manual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutomaticByOS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutomaticByPlatform"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ImageDefault"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutomaticByPlatform"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsVMGuestPatchAutomaticByPlatformSettings",
+ "properties": {
+ "rebootSetting": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations."
+ },
+ "bypassPlatformSafetyChecksOnUserSchedule": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Enables customer to schedule patching without accidental upgrades"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IfRequired"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Never"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Always"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/51"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WinRMConfiguration",
+ "properties": {
+ "listeners": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 0,
+ "description": "The list of Windows Remote Management listeners"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WinRMListener",
+ "properties": {
+ "protocol": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 0,
+ "description": "Specifies the protocol of WinRM listener. Possible values are: **http,** **https.**"
+ },
+ "certificateUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:
{ \"data\":\"\", \"dataType\":\"pfx\", \"password\":\"\" } To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Http"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Https"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/55"
+ },
+ {
+ "$ref": "#/56"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/54"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxConfiguration",
+ "properties": {
+ "disablePasswordAuthentication": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether password authentication should be disabled."
+ },
+ "ssh": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Specifies the ssh key configuration for a Linux OS."
+ },
+ "provisionVMAgent": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later."
+ },
+ "patchSettings": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux."
+ },
+ "enableVMAgentPlatformUpdates": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SshConfiguration",
+ "properties": {
+ "publicKeys": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 0,
+ "description": "The list of SSH public keys used to authenticate with linux based VMs."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SshPublicKey",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys"
+ },
+ "keyData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/61"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxPatchSettings",
+ "properties": {
+ "patchMode": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 0,
+ "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
**ImageDefault** - The virtual machine's default patching configuration is used.
**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true"
+ },
+ "assessmentMode": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 0,
+ "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.
Possible values are:
**ImageDefault** - You control the timing of patch assessments on a virtual machine.
**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true."
+ },
+ "automaticByPlatformSettings": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 0,
+ "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ImageDefault"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutomaticByPlatform"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ImageDefault"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutomaticByPlatform"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxVMGuestPatchAutomaticByPlatformSettings",
+ "properties": {
+ "rebootSetting": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations."
+ },
+ "bypassPlatformSafetyChecksOnUserSchedule": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Enables customer to schedule patching without accidental upgrades"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IfRequired"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Never"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Always"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/74"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VaultSecretGroup",
+ "properties": {
+ "sourceVault": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates."
+ },
+ "vaultCertificates": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 0,
+ "description": "The list of key vault references in SourceVault which contain certificates."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VaultCertificate",
+ "properties": {
+ "certificateUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
{ \"data\":\"\", \"dataType\":\"pfx\", \"password\":\"\" } To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ },
+ "certificateStore": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/78"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/76"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetStorageProfile",
+ "properties": {
+ "imageReference": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 0,
+ "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations."
+ },
+ "osDisk": {
+ "type": {
+ "$ref": "#/83"
+ },
+ "flags": 0,
+ "description": "Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "dataDisks": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "diskControllerType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageReference",
+ "properties": {
+ "publisher": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The image publisher."
+ },
+ "offer": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The image SKU."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input."
+ },
+ "exactVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'."
+ },
+ "sharedGalleryImageId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call."
+ },
+ "communityGalleryImageId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetOSDisk",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The disk name."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "createOption": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 1,
+ "description": "Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described."
+ },
+ "diffDiskSettings": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set."
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/103"
+ },
+ "flags": 0,
+ "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**"
+ },
+ "image": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "Specifies information about the unmanaged user image to base the scale set on."
+ },
+ "vhdContainers": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "Specifies the container urls that are used to store operating system disks for the scale set."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The managed disk parameters."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 0,
+ "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
Possible values:
**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.
**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.
The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FromImage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Empty"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Attach"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/88"
+ },
+ {
+ "$ref": "#/89"
+ },
+ {
+ "$ref": "#/90"
+ },
+ {
+ "$ref": "#/91"
+ },
+ {
+ "$ref": "#/92"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiffDiskSettings",
+ "properties": {
+ "option": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 0,
+ "description": "Specifies the ephemeral disk settings for operating system disk."
+ },
+ "placement": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Local"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CacheDisk"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ResourceDisk"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NvmeDisk"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/97"
+ },
+ {
+ "$ref": "#/98"
+ },
+ {
+ "$ref": "#/99"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualHardDisk",
+ "properties": {
+ "uri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the virtual hard disk's uri."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetManagedDiskParameters",
+ "properties": {
+ "storageAccountType": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "Specifies the security profile for the managed disk."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UltraSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PremiumV2_LRS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/107"
+ },
+ {
+ "$ref": "#/108"
+ },
+ {
+ "$ref": "#/109"
+ },
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskEncryptionSetParameters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VMDiskSecurityProfile",
+ "properties": {
+ "securityEncryptionType": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 0,
+ "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs."
+ },
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VMGuestStateOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DiskWithVMGuestState"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NonPersistedTPM"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/117"
+ },
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/121"
+ },
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetDataDisk",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The disk name."
+ },
+ "lun": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 1,
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/128"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "createOption": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 1,
+ "description": "The create option."
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The managed disk parameters."
+ },
+ "diskIOPSReadWrite": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB."
+ },
+ "diskMBpsReadWrite": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/137"
+ },
+ "flags": 0,
+ "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
Possible values:
**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.
**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.
The default value is set to **Delete**."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/125"
+ },
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FromImage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Empty"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Attach"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/132"
+ },
+ {
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/135"
+ },
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/124"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetNetworkProfile",
+ "properties": {
+ "healthProbe": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'."
+ },
+ "networkInterfaceConfigurations": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "The list of network configurations."
+ },
+ "networkApiVersion": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. For support of all network properties, use '2022-11-01'."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApiEntityReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetNetworkConfiguration",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The network configuration name."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 0,
+ "description": "Describes a virtual machine scale set network profile's IP configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetNetworkConfigurationProperties",
+ "properties": {
+ "primary": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "enableAcceleratedNetworking": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the network interface is accelerated networking-enabled."
+ },
+ "disableTcpStateTracking": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the network interface is disabled for tcp state tracking."
+ },
+ "enableFpga": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the network interface is FPGA networking-enabled."
+ },
+ "networkSecurityGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The network security group."
+ },
+ "dnsSettings": {
+ "type": {
+ "$ref": "#/143"
+ },
+ "flags": 0,
+ "description": "The dns settings to be applied on the network interfaces."
+ },
+ "ipConfigurations": {
+ "type": {
+ "$ref": "#/177"
+ },
+ "flags": 1,
+ "description": "Specifies the IP configurations of the network interface."
+ },
+ "enableIPForwarding": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether IP forwarding enabled on this NIC."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "Specify what happens to the network interface when the VM is deleted"
+ },
+ "auxiliaryMode": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource."
+ },
+ "auxiliarySku": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 0,
+ "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetNetworkConfigurationDnsSettings",
+ "properties": {
+ "dnsServers": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "List of DNS servers IP addresses"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetIPConfiguration",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The IP configuration name."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 0,
+ "description": "Describes a virtual machine scale set network profile's IP configuration properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetIPConfigurationProperties",
+ "properties": {
+ "subnet": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the identifier of the subnet."
+ },
+ "primary": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "publicIPAddressConfiguration": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The publicIPAddressConfiguration."
+ },
+ "privateIPAddressVersion": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 0,
+ "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'."
+ },
+ "applicationGatewayBackendAddressPools": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway."
+ },
+ "applicationSecurityGroups": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to application security group."
+ },
+ "loadBalancerBackendAddressPools": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer."
+ },
+ "loadBalancerInboundNatPools": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetPublicIPAddressConfiguration",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The publicIP address configuration name."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration"
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetPublicIPAddressConfigurationProperties",
+ "properties": {
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The idle timeout of the public IP address."
+ },
+ "dnsSettings": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "The dns settings to be applied on the publicIP addresses ."
+ },
+ "ipTags": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 0,
+ "description": "The list of IP tags associated with the public IP address."
+ },
+ "publicIPPrefix": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The PublicIPPrefix from which to allocate publicIP addresses."
+ },
+ "publicIPAddressVersion": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "Specify what happens to the public IP when the VM is deleted"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings",
+ "properties": {
+ "domainNameLabel": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created"
+ },
+ "domainNameLabelScope": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 0,
+ "description": "The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TenantReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SubscriptionReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ResourceGroupReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoReuse"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/152"
+ },
+ {
+ "$ref": "#/153"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetIpTag",
+ "properties": {
+ "ipTagType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "IP tag type. Example: FirstPartyUsage."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "IP tag associated with the public IP. Example: SQL, Storage etc."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/155"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PublicIPAddressSku",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 0,
+ "description": "Specify public IP sku name"
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "Specify public IP sku tier"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/165"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regional"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Global"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/145"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/179"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AcceleratedConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Floating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/181"
+ },
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A8"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/185"
+ },
+ {
+ "$ref": "#/186"
+ },
+ {
+ "$ref": "#/187"
+ },
+ {
+ "$ref": "#/188"
+ },
+ {
+ "$ref": "#/189"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/141"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2020-11-01"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2022-11-01"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecurityProfile",
+ "properties": {
+ "uefiSettings": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01."
+ },
+ "encryptionAtHost": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource."
+ },
+ "securityType": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set."
+ },
+ "encryptionIdentity": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations."
+ },
+ "proxyAgentSettings": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 0,
+ "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UefiSettings",
+ "properties": {
+ "secureBootEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01."
+ },
+ "vTpmEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TrustedLaunch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfidentialVM"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/197"
+ },
+ {
+ "$ref": "#/198"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionIdentity",
+ "properties": {
+ "userAssignedIdentityResourceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies ARM Resource ID of one of the user identities associated with the VM."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProxyAgentSettings",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting."
+ },
+ "keyIncarnationId": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Increase the value of this property allows users to reset the key used for securing communication channel between guest and host."
+ },
+ "wireServer": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 0,
+ "description": "Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01."
+ },
+ "imds": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 0,
+ "description": "Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Audit"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enforce"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/203"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "HostEndpointSettings",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/209"
+ },
+ "flags": 0,
+ "description": "Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation."
+ },
+ "inVMAccessControlProfileReferenceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Audit"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enforce"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/206"
+ },
+ {
+ "$ref": "#/207"
+ },
+ {
+ "$ref": "#/208"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiagnosticsProfile",
+ "properties": {
+ "bootDiagnostics": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 0,
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BootDiagnostics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether boot diagnostics should be enabled on the Virtual Machine."
+ },
+ "storageUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetExtensionProfile",
+ "properties": {
+ "extensions": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 0,
+ "description": "The virtual machine scale set child extension resources."
+ },
+ "extensionsTimeBudget": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetExtension",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the extension."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource type"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine Scale Set Extension."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetExtensionProperties",
+ "properties": {
+ "forceUpdateTag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed."
+ },
+ "publisher": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the extension handler publisher."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the version of the script handler."
+ },
+ "autoUpgradeMinorVersion": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true."
+ },
+ "enableAutomaticUpgrade": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
+ },
+ "settings": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "Json formatted public settings for the extension."
+ },
+ "protectedSettings": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "provisionAfterExtensions": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 0,
+ "description": "Collection of extension names after which this extension needs to be provisioned."
+ },
+ "suppressFailures": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false."
+ },
+ "protectedSettingsFromKeyVault": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "The extensions protected settings that are passed by reference, and consumed from key vault"
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyVaultSecretReference",
+ "properties": {
+ "secretUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The URL referencing a secret in a Key Vault."
+ },
+ "sourceVault": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 1,
+ "description": "The relative URL of the Key Vault containing the secret."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/213"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Low"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/219"
+ },
+ {
+ "$ref": "#/220"
+ },
+ {
+ "$ref": "#/221"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/223"
+ },
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BillingProfile",
+ "properties": {
+ "maxPrice": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.
This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.
The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.
Possible values are:
- Any decimal value greater than zero. Example: 0.01538
-1 – indicates default price to be up-to on-demand.
You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.
Minimum api-version: 2019-03-01."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduledEventsProfile",
+ "properties": {
+ "terminateNotificationProfile": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "Specifies Terminate Scheduled Event related configurations."
+ },
+ "osImageNotificationProfile": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "Specifies OS Image Scheduled Event related configurations."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TerminateNotificationProfile",
+ "properties": {
+ "notBeforeTimeout": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)"
+ },
+ "enable": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the Terminate Scheduled event is enabled or disabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OSImageNotificationProfile",
+ "properties": {
+ "notBeforeTimeout": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M)"
+ },
+ "enable": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the OS Image Scheduled event is enabled or disabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationProfile",
+ "properties": {
+ "capacityReservationGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApplicationProfile",
+ "properties": {
+ "galleryApplications": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 0,
+ "description": "Specifies the gallery applications that should be made available to the VM/VMSS"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VMGalleryApplication",
+ "properties": {
+ "tags": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Optional, Specifies a passthrough value for more generic context."
+ },
+ "order": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Optional, Specifies the order in which the packages have to be installed"
+ },
+ "packageReferenceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}"
+ },
+ "configurationReference": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided"
+ },
+ "treatFailureAsDeploymentFailure": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Optional, If true, any failure for any operation in the VmApplication will fail the deployment"
+ },
+ "enableAutomaticUpgrade": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/232"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetHardwareProfile",
+ "properties": {
+ "vmSizeProperties": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VMSizeProperties",
+ "properties": {
+ "vCPUsAvailable": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)."
+ },
+ "vCPUsPerCore": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.**"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServiceArtifactReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecurityPostureReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest"
+ },
+ "excludeExtensions": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 0,
+ "description": "The list of virtual machine extension names to exclude when applying the security posture."
+ },
+ "isOverridable": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether the security posture can be overridden by the user."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdditionalCapabilities",
+ "properties": {
+ "ultraSSDEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled."
+ },
+ "hibernationEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "The flag that enables or disables hibernation capability on the VM."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScaleInPolicy",
+ "properties": {
+ "rules": {
+ "type": {
+ "$ref": "#/245"
+ },
+ "flags": 0,
+ "description": "The rules to be followed when scaling-in a virtual machine scale set.
Possible values are:
**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.
**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.
**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.
"
+ },
+ "forceDeletion": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)"
+ },
+ "prioritizeUnhealthyVMs": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OldestVM"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NewestVM"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/241"
+ },
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/243"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/244"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uniform"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Flexible"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SpotRestorePolicy",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints"
+ },
+ "restoreTimeout": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PriorityMixPolicy",
+ "properties": {
+ "baseRegularPriorityCount": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 0,
+ "description": "The base number of regular priority VMs that will be created in this scale set as it scales out."
+ },
+ "regularPriorityPercentageAboveBase": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResiliencyPolicy",
+ "properties": {
+ "resilientVMCreationPolicy": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while performing resilient VM creation."
+ },
+ "resilientVMDeletionPolicy": {
+ "type": {
+ "$ref": "#/254"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while performing resilient VM deletion."
+ },
+ "automaticZoneRebalancingPolicy": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 0,
+ "description": "The configuration parameters used while performing automatic AZ balancing."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResilientVMCreationPolicy",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResilientVMDeletionPolicy",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutomaticZoneRebalancingPolicy",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false."
+ },
+ "rebalanceStrategy": {
+ "type": {
+ "$ref": "#/257"
+ },
+ "flags": 0,
+ "description": "Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate."
+ },
+ "rebalanceBehavior": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Recreate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateBeforeDelete"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/258"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Aligned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unaligned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/260"
+ },
+ {
+ "$ref": "#/261"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SkuProfile",
+ "properties": {
+ "vmSizes": {
+ "type": {
+ "$ref": "#/265"
+ },
+ "flags": 0,
+ "description": "Specifies the VM sizes for the virtual machine scale set."
+ },
+ "allocationStrategy": {
+ "type": {
+ "$ref": "#/269"
+ },
+ "flags": 0,
+ "description": "Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SkuProfileVMSize",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the name of the VM Size."
+ },
+ "rank": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 0,
+ "description": "Specifies the rank (a.k.a priority) associated with the VM Size."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/264"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LowestPrice"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CapacityOptimized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Prioritized"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/267"
+ },
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 0,
+ "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 0,
+ "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned, UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/272"
+ },
+ {
+ "$ref": "#/273"
+ },
+ {
+ "$ref": "#/274"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/276"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExtendedLocation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 0,
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EdgeZone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/3"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachineScaleSets/extensions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/extensions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/284"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine Scale Set Extension."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/extensions@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/286"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/289"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the extension."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine Extension."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineExtensionProperties",
+ "properties": {
+ "forceUpdateTag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "How the extension handler should be forced to update even if the extension configuration has not changed."
+ },
+ "publisher": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the extension handler publisher."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the version of the script handler."
+ },
+ "autoUpgradeMinorVersion": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true."
+ },
+ "enableAutomaticUpgrade": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
+ },
+ "settings": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "Json formatted public settings for the extension."
+ },
+ "protectedSettings": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 0,
+ "description": "The virtual machine extension instance view."
+ },
+ "suppressFailures": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false."
+ },
+ "protectedSettingsFromKeyVault": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "The extensions protected settings that are passed by reference, and consumed from key vault"
+ },
+ "provisionAfterExtensions": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 0,
+ "description": "Collection of extension names after which this extension needs to be provisioned."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineExtensionInstanceView",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The virtual machine extension name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the version of the script handler."
+ },
+ "substatuses": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InstanceViewStatus",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The status code."
+ },
+ "level": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 0,
+ "description": "The level code."
+ },
+ "displayStatus": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The short localizable label for the status."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The detailed status message, including for alerts and error messages."
+ },
+ "time": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The time of the status."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Info"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/296"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/290"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "instanceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The virtual machine instance ID."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 2,
+ "description": "The virtual machine SKU."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a virtual machine scale set virtual machine."
+ },
+ "plan": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/613"
+ },
+ "flags": 2,
+ "description": "The virtual machine child extension resources."
+ },
+ "zones": {
+ "type": {
+ "$ref": "#/614"
+ },
+ "flags": 2,
+ "description": "The virtual machine zones."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/615"
+ },
+ "flags": 0,
+ "description": "The identity of the virtual machine, if configured."
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/622"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMProperties",
+ "properties": {
+ "latestModelApplied": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Specifies whether the latest model has been applied to the virtual machine."
+ },
+ "vmId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Azure VM unique ID."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 2,
+ "description": "The virtual machine instance view."
+ },
+ "hardwareProfile": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 0,
+ "description": "Specifies the hardware settings for the virtual machine."
+ },
+ "resilientVMDeletionStatus": {
+ "type": {
+ "$ref": "#/502"
+ },
+ "flags": 0,
+ "description": "Specifies the resilient VM deletion status for the virtual machine."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/503"
+ },
+ "flags": 0,
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "additionalCapabilities": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 0,
+ "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type."
+ },
+ "osProfile": {
+ "type": {
+ "$ref": "#/550"
+ },
+ "flags": 0,
+ "description": "Specifies the operating system settings for the virtual machine."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Specifies the Security related profile settings for the virtual machine."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/552"
+ },
+ "flags": 0,
+ "description": "Specifies the network interfaces of the virtual machine."
+ },
+ "networkProfileConfiguration": {
+ "type": {
+ "$ref": "#/608"
+ },
+ "flags": 0,
+ "description": "Specifies the network profile configuration of the virtual machine."
+ },
+ "diagnosticsProfile": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 0,
+ "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15."
+ },
+ "availabilitySet": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies that the image or disk that is being used was licensed on-premises.
Possible values for Windows Server operating system are:
Windows_Client
Windows_Server
Possible values for Linux Server operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS (for SUSE)
For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
Minimum api-version: 2015-06-15"
+ },
+ "modelDefinitionApplied": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine."
+ },
+ "protectionPolicy": {
+ "type": {
+ "$ref": "#/610"
+ },
+ "flags": 0,
+ "description": "Specifies the protection policy of the virtual machine."
+ },
+ "userData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01"
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMInstanceView",
+ "properties": {
+ "platformUpdateDomain": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The Update Domain count."
+ },
+ "platformFaultDomain": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The Fault Domain count."
+ },
+ "rdpThumbPrint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Remote desktop certificate thumbprint."
+ },
+ "vmAgent": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "The VM Agent running on the virtual machine."
+ },
+ "maintenanceRedeployStatus": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 0,
+ "description": "The Maintenance Operation status on the virtual machine."
+ },
+ "disks": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 0,
+ "description": "The disks information."
+ },
+ "extensions": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 0,
+ "description": "The extensions information."
+ },
+ "vmHealth": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 2,
+ "description": "The application health status for the VM, provided through Application Health Extension or Load Balancer Health Probes."
+ },
+ "bootDiagnostics": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 0,
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ },
+ "assignedHost": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01."
+ },
+ "placementGroupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId."
+ },
+ "computerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the host OS name of the virtual machine.
This name cannot be updated after the VM is created.
**Max-length (Windows):** 15 characters
**Max-length (Linux):** 64 characters.
For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)."
+ },
+ "osName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Operating System running on the hybrid machine."
+ },
+ "osVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The version of Operating System running on the hybrid machine."
+ },
+ "hyperVGeneration": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 0,
+ "description": "The hypervisor generation of the Virtual Machine [V1, V2]"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineAgentInstanceView",
+ "properties": {
+ "vmAgentVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The VM Agent full version."
+ },
+ "extensionHandlers": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The virtual machine extension handler instance view."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineExtensionHandlerInstanceView",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the version of the script handler."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "The extension handler status."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/308"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceRedeployStatus",
+ "properties": {
+ "isCustomerInitiatedMaintenanceAllowed": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "True, if customer is allowed to perform Maintenance."
+ },
+ "preMaintenanceWindowStartTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Start Time for the Pre Maintenance Window."
+ },
+ "preMaintenanceWindowEndTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "End Time for the Pre Maintenance Window."
+ },
+ "maintenanceWindowStartTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Start Time for the Maintenance Window."
+ },
+ "maintenanceWindowEndTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "End Time for the Maintenance Window."
+ },
+ "lastOperationResultCode": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 0,
+ "description": "The Last Maintenance Operation Result Code."
+ },
+ "lastOperationMessage": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Message returned for the last Maintenance Operation."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RetryLater"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MaintenanceAborted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MaintenanceCompleted"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/312"
+ },
+ {
+ "$ref": "#/313"
+ },
+ {
+ "$ref": "#/314"
+ },
+ {
+ "$ref": "#/315"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskInstanceView",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The disk name."
+ },
+ "encryptionSettings": {
+ "type": {
+ "$ref": "#/320"
+ },
+ "flags": 0,
+ "description": "Specifies the encryption settings for the OS Disk.
Minimum api-version: 2015-06-15"
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskEncryptionSettings",
+ "properties": {
+ "diskEncryptionKey": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret."
+ },
+ "keyEncryptionKey": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "Specifies the location of the key encryption key in Key Vault."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether disk encryption should be enabled on the virtual machine."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyVaultKeyReference",
+ "properties": {
+ "keyUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The URL referencing a key encryption key in Key Vault."
+ },
+ "sourceVault": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 1,
+ "description": "The relative URL of the Key Vault containing the key."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/318"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/317"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/292"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineHealthStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 2,
+ "description": "The health status information for the VM."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BootDiagnosticsInstanceView",
+ "properties": {
+ "consoleScreenshotBlobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage."
+ },
+ "serialConsoleLogBlobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 2,
+ "description": "The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/327"
+ },
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "HardwareProfile",
+ "properties": {
+ "vmSize": {
+ "type": {
+ "$ref": "#/497"
+ },
+ "flags": 0,
+ "description": "Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set."
+ },
+ "vmSizeProperties": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic_A0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic_A1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic_A2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic_A3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic_A4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A5"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A6"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A7"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A9"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A10"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A11"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A1_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A2_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A4_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A8_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A2m_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A4m_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_A8m_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_B1s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_B1ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_B2s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_B2ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_B4ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_B8ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D11"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D12"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D13"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D14"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D1_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D2_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D3_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D4_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D5_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D2_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D4_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D8_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D16_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D32_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D64_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D2s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D4s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D8s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D16s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D32s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D64s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D11_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D12_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D13_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D14_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_D15_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS11"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS12"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS13"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS14"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS1_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS2_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS3_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS4_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS5_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS11_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS12_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS13_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS14_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS15_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS13-4_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS13-2_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS14-8_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_DS14-4_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E2_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E4_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E8_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E16_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E32_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E64_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E2s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E4s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E8s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E16s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E32s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E64s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E32-16_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E32-8s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E64-32s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_E64-16s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F16"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F1s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F2s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F4s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F8s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F16s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F2s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F4s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F8s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F16s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F32s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F64s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_F72s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_G1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_G2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_G3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_G4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_G5"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS5"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS4-8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS4-4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS5-16"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_GS5-8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_H8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_H16"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_H8m"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_H16m"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_H16r"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_H16mr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_L4s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_L8s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_L16s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_L32s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M64s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M64ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M128s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M128ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M64-32ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M64-16ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M128-64ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_M128-32ms"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC6"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC12"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC24"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC24r"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC6s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC12s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC24s_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC24rs_v2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC6s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC12s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC24s_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NC24rs_v3"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_ND6s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_ND12s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_ND24s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_ND24rs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NV6"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NV12"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_NV24"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/331"
+ },
+ {
+ "$ref": "#/332"
+ },
+ {
+ "$ref": "#/333"
+ },
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/335"
+ },
+ {
+ "$ref": "#/336"
+ },
+ {
+ "$ref": "#/337"
+ },
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/343"
+ },
+ {
+ "$ref": "#/344"
+ },
+ {
+ "$ref": "#/345"
+ },
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/347"
+ },
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ },
+ {
+ "$ref": "#/350"
+ },
+ {
+ "$ref": "#/351"
+ },
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/353"
+ },
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/355"
+ },
+ {
+ "$ref": "#/356"
+ },
+ {
+ "$ref": "#/357"
+ },
+ {
+ "$ref": "#/358"
+ },
+ {
+ "$ref": "#/359"
+ },
+ {
+ "$ref": "#/360"
+ },
+ {
+ "$ref": "#/361"
+ },
+ {
+ "$ref": "#/362"
+ },
+ {
+ "$ref": "#/363"
+ },
+ {
+ "$ref": "#/364"
+ },
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/366"
+ },
+ {
+ "$ref": "#/367"
+ },
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/370"
+ },
+ {
+ "$ref": "#/371"
+ },
+ {
+ "$ref": "#/372"
+ },
+ {
+ "$ref": "#/373"
+ },
+ {
+ "$ref": "#/374"
+ },
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/376"
+ },
+ {
+ "$ref": "#/377"
+ },
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/382"
+ },
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/384"
+ },
+ {
+ "$ref": "#/385"
+ },
+ {
+ "$ref": "#/386"
+ },
+ {
+ "$ref": "#/387"
+ },
+ {
+ "$ref": "#/388"
+ },
+ {
+ "$ref": "#/389"
+ },
+ {
+ "$ref": "#/390"
+ },
+ {
+ "$ref": "#/391"
+ },
+ {
+ "$ref": "#/392"
+ },
+ {
+ "$ref": "#/393"
+ },
+ {
+ "$ref": "#/394"
+ },
+ {
+ "$ref": "#/395"
+ },
+ {
+ "$ref": "#/396"
+ },
+ {
+ "$ref": "#/397"
+ },
+ {
+ "$ref": "#/398"
+ },
+ {
+ "$ref": "#/399"
+ },
+ {
+ "$ref": "#/400"
+ },
+ {
+ "$ref": "#/401"
+ },
+ {
+ "$ref": "#/402"
+ },
+ {
+ "$ref": "#/403"
+ },
+ {
+ "$ref": "#/404"
+ },
+ {
+ "$ref": "#/405"
+ },
+ {
+ "$ref": "#/406"
+ },
+ {
+ "$ref": "#/407"
+ },
+ {
+ "$ref": "#/408"
+ },
+ {
+ "$ref": "#/409"
+ },
+ {
+ "$ref": "#/410"
+ },
+ {
+ "$ref": "#/411"
+ },
+ {
+ "$ref": "#/412"
+ },
+ {
+ "$ref": "#/413"
+ },
+ {
+ "$ref": "#/414"
+ },
+ {
+ "$ref": "#/415"
+ },
+ {
+ "$ref": "#/416"
+ },
+ {
+ "$ref": "#/417"
+ },
+ {
+ "$ref": "#/418"
+ },
+ {
+ "$ref": "#/419"
+ },
+ {
+ "$ref": "#/420"
+ },
+ {
+ "$ref": "#/421"
+ },
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/424"
+ },
+ {
+ "$ref": "#/425"
+ },
+ {
+ "$ref": "#/426"
+ },
+ {
+ "$ref": "#/427"
+ },
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/429"
+ },
+ {
+ "$ref": "#/430"
+ },
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/435"
+ },
+ {
+ "$ref": "#/436"
+ },
+ {
+ "$ref": "#/437"
+ },
+ {
+ "$ref": "#/438"
+ },
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/440"
+ },
+ {
+ "$ref": "#/441"
+ },
+ {
+ "$ref": "#/442"
+ },
+ {
+ "$ref": "#/443"
+ },
+ {
+ "$ref": "#/444"
+ },
+ {
+ "$ref": "#/445"
+ },
+ {
+ "$ref": "#/446"
+ },
+ {
+ "$ref": "#/447"
+ },
+ {
+ "$ref": "#/448"
+ },
+ {
+ "$ref": "#/449"
+ },
+ {
+ "$ref": "#/450"
+ },
+ {
+ "$ref": "#/451"
+ },
+ {
+ "$ref": "#/452"
+ },
+ {
+ "$ref": "#/453"
+ },
+ {
+ "$ref": "#/454"
+ },
+ {
+ "$ref": "#/455"
+ },
+ {
+ "$ref": "#/456"
+ },
+ {
+ "$ref": "#/457"
+ },
+ {
+ "$ref": "#/458"
+ },
+ {
+ "$ref": "#/459"
+ },
+ {
+ "$ref": "#/460"
+ },
+ {
+ "$ref": "#/461"
+ },
+ {
+ "$ref": "#/462"
+ },
+ {
+ "$ref": "#/463"
+ },
+ {
+ "$ref": "#/464"
+ },
+ {
+ "$ref": "#/465"
+ },
+ {
+ "$ref": "#/466"
+ },
+ {
+ "$ref": "#/467"
+ },
+ {
+ "$ref": "#/468"
+ },
+ {
+ "$ref": "#/469"
+ },
+ {
+ "$ref": "#/470"
+ },
+ {
+ "$ref": "#/471"
+ },
+ {
+ "$ref": "#/472"
+ },
+ {
+ "$ref": "#/473"
+ },
+ {
+ "$ref": "#/474"
+ },
+ {
+ "$ref": "#/475"
+ },
+ {
+ "$ref": "#/476"
+ },
+ {
+ "$ref": "#/477"
+ },
+ {
+ "$ref": "#/478"
+ },
+ {
+ "$ref": "#/479"
+ },
+ {
+ "$ref": "#/480"
+ },
+ {
+ "$ref": "#/481"
+ },
+ {
+ "$ref": "#/482"
+ },
+ {
+ "$ref": "#/483"
+ },
+ {
+ "$ref": "#/484"
+ },
+ {
+ "$ref": "#/485"
+ },
+ {
+ "$ref": "#/486"
+ },
+ {
+ "$ref": "#/487"
+ },
+ {
+ "$ref": "#/488"
+ },
+ {
+ "$ref": "#/489"
+ },
+ {
+ "$ref": "#/490"
+ },
+ {
+ "$ref": "#/491"
+ },
+ {
+ "$ref": "#/492"
+ },
+ {
+ "$ref": "#/493"
+ },
+ {
+ "$ref": "#/494"
+ },
+ {
+ "$ref": "#/495"
+ },
+ {
+ "$ref": "#/496"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/498"
+ },
+ {
+ "$ref": "#/499"
+ },
+ {
+ "$ref": "#/500"
+ },
+ {
+ "$ref": "#/501"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "StorageProfile",
+ "properties": {
+ "imageReference": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 0,
+ "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations."
+ },
+ "osDisk": {
+ "type": {
+ "$ref": "#/504"
+ },
+ "flags": 0,
+ "description": "Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "dataDisks": {
+ "type": {
+ "$ref": "#/546"
+ },
+ "flags": 0,
+ "description": "Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "diskControllerType": {
+ "type": {
+ "$ref": "#/549"
+ },
+ "flags": 0,
+ "description": "Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01."
+ },
+ "alignRegionalDisksToVMZone": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OSDisk",
+ "properties": {
+ "osType": {
+ "type": {
+ "$ref": "#/507"
+ },
+ "flags": 0,
+ "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**"
+ },
+ "encryptionSettings": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 0,
+ "description": "Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The disk name."
+ },
+ "vhd": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The virtual hard disk."
+ },
+ "image": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/511"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "diffDiskSettings": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine."
+ },
+ "createOption": {
+ "type": {
+ "$ref": "#/517"
+ },
+ "flags": 1,
+ "description": "Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described."
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "The managed disk parameters."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/529"
+ },
+ "flags": 0,
+ "description": "Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/505"
+ },
+ {
+ "$ref": "#/506"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/508"
+ },
+ {
+ "$ref": "#/509"
+ },
+ {
+ "$ref": "#/510"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FromImage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Empty"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Attach"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/512"
+ },
+ {
+ "$ref": "#/513"
+ },
+ {
+ "$ref": "#/514"
+ },
+ {
+ "$ref": "#/515"
+ },
+ {
+ "$ref": "#/516"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedDiskParameters",
+ "properties": {
+ "storageAccountType": {
+ "type": {
+ "$ref": "#/526"
+ },
+ "flags": 0,
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "Specifies the security profile for the managed disk."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UltraSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PremiumV2_LRS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/519"
+ },
+ {
+ "$ref": "#/520"
+ },
+ {
+ "$ref": "#/521"
+ },
+ {
+ "$ref": "#/522"
+ },
+ {
+ "$ref": "#/523"
+ },
+ {
+ "$ref": "#/524"
+ },
+ {
+ "$ref": "#/525"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/527"
+ },
+ {
+ "$ref": "#/528"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataDisk",
+ "properties": {
+ "lun": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 1,
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The disk name."
+ },
+ "vhd": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The virtual hard disk."
+ },
+ "image": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/534"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "createOption": {
+ "type": {
+ "$ref": "#/540"
+ },
+ "flags": 1,
+ "description": "Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point."
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "The managed disk parameters."
+ },
+ "sourceResource": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk."
+ },
+ "toBeDetached": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset"
+ },
+ "diskIOPSReadWrite": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set."
+ },
+ "diskMBpsReadWrite": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set."
+ },
+ "detachOption": {
+ "type": {
+ "$ref": "#/542"
+ },
+ "flags": 0,
+ "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/545"
+ },
+ "flags": 0,
+ "description": "Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/531"
+ },
+ {
+ "$ref": "#/532"
+ },
+ {
+ "$ref": "#/533"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FromImage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Empty"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Attach"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/535"
+ },
+ {
+ "$ref": "#/536"
+ },
+ {
+ "$ref": "#/537"
+ },
+ {
+ "$ref": "#/538"
+ },
+ {
+ "$ref": "#/539"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForceDetach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/541"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/543"
+ },
+ {
+ "$ref": "#/544"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/530"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SCSI"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NVMe"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/547"
+ },
+ {
+ "$ref": "#/548"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OSProfile",
+ "properties": {
+ "computerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules)."
+ },
+ "adminUsername": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the name of the administrator account.
This property cannot be updated after the VM is created.
**Max-length (Windows):** 20 characters."
+ },
+ "adminPassword": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)"
+ },
+ "customData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)."
+ },
+ "windowsConfiguration": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "Specifies Windows operating system settings on the virtual machine."
+ },
+ "linuxConfiguration": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
+ },
+ "secrets": {
+ "type": {
+ "$ref": "#/551"
+ },
+ "flags": 0,
+ "description": "Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ },
+ "allowExtensionOperations": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine."
+ },
+ "requireGuestProvisionSignal": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Optional property which must either be set to True or omitted."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/76"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkProfile",
+ "properties": {
+ "networkInterfaces": {
+ "type": {
+ "$ref": "#/558"
+ },
+ "flags": 0,
+ "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine."
+ },
+ "networkApiVersion": {
+ "type": {
+ "$ref": "#/561"
+ },
+ "flags": 0,
+ "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations"
+ },
+ "networkInterfaceConfigurations": {
+ "type": {
+ "$ref": "#/607"
+ },
+ "flags": 0,
+ "description": "Specifies the networking configurations that will be used to create the virtual machine networking resources."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkInterfaceReference",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/554"
+ },
+ "flags": 0,
+ "description": "Describes a network interface reference properties."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkInterfaceReferenceProperties",
+ "properties": {
+ "primary": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/557"
+ },
+ "flags": 0,
+ "description": "Specify what happens to the network interface when the VM is deleted"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/555"
+ },
+ {
+ "$ref": "#/556"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/553"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2020-11-01"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2022-11-01"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/559"
+ },
+ {
+ "$ref": "#/560"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNetworkInterfaceConfiguration",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The network interface configuration name."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/563"
+ },
+ "flags": 0,
+ "description": "Describes a virtual machine network profile's IP configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNetworkInterfaceConfigurationProperties",
+ "properties": {
+ "primary": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/566"
+ },
+ "flags": 0,
+ "description": "Specify what happens to the network interface when the VM is deleted"
+ },
+ "enableAcceleratedNetworking": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the network interface is accelerated networking-enabled."
+ },
+ "disableTcpStateTracking": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the network interface is disabled for tcp state tracking."
+ },
+ "enableFpga": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the network interface is FPGA networking-enabled."
+ },
+ "enableIPForwarding": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether IP forwarding enabled on this NIC."
+ },
+ "networkSecurityGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The network security group."
+ },
+ "dnsSettings": {
+ "type": {
+ "$ref": "#/567"
+ },
+ "flags": 0,
+ "description": "The dns settings to be applied on the network interfaces."
+ },
+ "ipConfigurations": {
+ "type": {
+ "$ref": "#/596"
+ },
+ "flags": 1,
+ "description": "Specifies the IP configurations of the network interface."
+ },
+ "dscpConfiguration": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0
+ },
+ "auxiliaryMode": {
+ "type": {
+ "$ref": "#/600"
+ },
+ "flags": 0,
+ "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource."
+ },
+ "auxiliarySku": {
+ "type": {
+ "$ref": "#/606"
+ },
+ "flags": 0,
+ "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/564"
+ },
+ {
+ "$ref": "#/565"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNetworkInterfaceDnsSettingsConfiguration",
+ "properties": {
+ "dnsServers": {
+ "type": {
+ "$ref": "#/568"
+ },
+ "flags": 0,
+ "description": "List of DNS servers IP addresses"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNetworkInterfaceIPConfiguration",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The IP configuration name."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/570"
+ },
+ "flags": 0,
+ "description": "Describes a virtual machine network interface IP configuration properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNetworkInterfaceIPConfigurationProperties",
+ "properties": {
+ "subnet": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies the identifier of the subnet."
+ },
+ "primary": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "publicIPAddressConfiguration": {
+ "type": {
+ "$ref": "#/571"
+ },
+ "flags": 0,
+ "description": "The publicIPAddressConfiguration."
+ },
+ "privateIPAddressVersion": {
+ "type": {
+ "$ref": "#/592"
+ },
+ "flags": 0,
+ "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'."
+ },
+ "applicationSecurityGroups": {
+ "type": {
+ "$ref": "#/593"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to application security group."
+ },
+ "applicationGatewayBackendAddressPools": {
+ "type": {
+ "$ref": "#/594"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway."
+ },
+ "loadBalancerBackendAddressPools": {
+ "type": {
+ "$ref": "#/595"
+ },
+ "flags": 0,
+ "description": "Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachinePublicIPAddressConfiguration",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The publicIP address configuration name."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/572"
+ },
+ "flags": 0,
+ "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration"
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachinePublicIPAddressConfigurationProperties",
+ "properties": {
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The idle timeout of the public IP address."
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/575"
+ },
+ "flags": 0,
+ "description": "Specify what happens to the public IP address when the VM is deleted"
+ },
+ "dnsSettings": {
+ "type": {
+ "$ref": "#/576"
+ },
+ "flags": 0,
+ "description": "The dns settings to be applied on the publicIP addresses ."
+ },
+ "ipTags": {
+ "type": {
+ "$ref": "#/583"
+ },
+ "flags": 0,
+ "description": "The list of IP tags associated with the public IP address."
+ },
+ "publicIPPrefix": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The PublicIPPrefix from which to allocate publicIP addresses."
+ },
+ "publicIPAddressVersion": {
+ "type": {
+ "$ref": "#/586"
+ },
+ "flags": 0,
+ "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'."
+ },
+ "publicIPAllocationMethod": {
+ "type": {
+ "$ref": "#/589"
+ },
+ "flags": 0,
+ "description": "Specify the public IP allocation type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/573"
+ },
+ {
+ "$ref": "#/574"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachinePublicIPAddressDnsSettingsConfiguration",
+ "properties": {
+ "domainNameLabel": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID."
+ },
+ "domainNameLabelScope": {
+ "type": {
+ "$ref": "#/581"
+ },
+ "flags": 0,
+ "description": "The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TenantReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SubscriptionReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ResourceGroupReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoReuse"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/577"
+ },
+ {
+ "$ref": "#/578"
+ },
+ {
+ "$ref": "#/579"
+ },
+ {
+ "$ref": "#/580"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineIpTag",
+ "properties": {
+ "ipTagType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "IP tag type. Example: FirstPartyUsage."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "IP tag associated with the public IP. Example: SQL, Storage etc."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/582"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/584"
+ },
+ {
+ "$ref": "#/585"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dynamic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Static"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/587"
+ },
+ {
+ "$ref": "#/588"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/590"
+ },
+ {
+ "$ref": "#/591"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/569"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AcceleratedConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Floating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/597"
+ },
+ {
+ "$ref": "#/598"
+ },
+ {
+ "$ref": "#/599"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "A8"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/601"
+ },
+ {
+ "$ref": "#/602"
+ },
+ {
+ "$ref": "#/603"
+ },
+ {
+ "$ref": "#/604"
+ },
+ {
+ "$ref": "#/605"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/562"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMNetworkProfileConfiguration",
+ "properties": {
+ "networkInterfaceConfigurations": {
+ "type": {
+ "$ref": "#/609"
+ },
+ "flags": 0,
+ "description": "The list of network configurations."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/141"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMProtectionPolicy",
+ "properties": {
+ "protectFromScaleIn": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation."
+ },
+ "protectFromScaleSetActions": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineExtension",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine Extension."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource location"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource type"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/612"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceWithOptionalLocationTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/611"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/620"
+ },
+ "flags": 0,
+ "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/621"
+ },
+ "flags": 0,
+ "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned, UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/616"
+ },
+ {
+ "$ref": "#/617"
+ },
+ {
+ "$ref": "#/618"
+ },
+ {
+ "$ref": "#/619"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/276"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/304"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachines/extensions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachines/extensions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/624"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/625"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine Extension."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/627"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceWithOptionalLocationTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachines/extensions@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/626"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/629"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/630"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "plan": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/632"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine."
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/667"
+ },
+ "flags": 2,
+ "description": "The virtual machine child extension resources."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/615"
+ },
+ "flags": 0,
+ "description": "The identity of the virtual machine, if configured."
+ },
+ "zones": {
+ "type": {
+ "$ref": "#/668"
+ },
+ "flags": 0,
+ "description": "The virtual machine zones."
+ },
+ "extendedLocation": {
+ "type": {
+ "$ref": "#/279"
+ },
+ "flags": 0,
+ "description": "The extended location of the Virtual Machine."
+ },
+ "managedBy": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization."
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates."
+ },
+ "placement": {
+ "type": {
+ "$ref": "#/669"
+ },
+ "flags": 0,
+ "description": "Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/674"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineProperties",
+ "properties": {
+ "hardwareProfile": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 0,
+ "description": "Specifies the hardware settings for the virtual machine."
+ },
+ "scheduledEventsPolicy": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/503"
+ },
+ "flags": 0,
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "additionalCapabilities": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 0,
+ "description": "Specifies additional capabilities enabled or disabled on the virtual machine."
+ },
+ "osProfile": {
+ "type": {
+ "$ref": "#/550"
+ },
+ "flags": 0,
+ "description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/552"
+ },
+ "flags": 0,
+ "description": "Specifies the network interfaces of the virtual machine."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Specifies the Security related profile settings for the virtual machine."
+ },
+ "diagnosticsProfile": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 0,
+ "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15."
+ },
+ "availabilitySet": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference."
+ },
+ "virtualMachineScaleSet": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01."
+ },
+ "proximityPlacementGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01."
+ },
+ "priority": {
+ "type": {
+ "$ref": "#/636"
+ },
+ "flags": 0,
+ "description": "Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01"
+ },
+ "evictionPolicy": {
+ "type": {
+ "$ref": "#/639"
+ },
+ "flags": 0,
+ "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
+ },
+ "billingProfile": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01."
+ },
+ "host": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01."
+ },
+ "hostGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/640"
+ },
+ "flags": 2,
+ "description": "The virtual machine instance view."
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies that the image or disk that is being used was licensed on-premises.
Possible values for Windows Server operating system are:
Windows_Client
Windows_Server
Possible values for Linux Server operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS (for SUSE)
For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
Minimum api-version: 2015-06-15"
+ },
+ "vmId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands."
+ },
+ "extensionsTimeBudget": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01."
+ },
+ "platformFaultDomain": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01."
+ },
+ "scheduledEventsProfile": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "Specifies Scheduled Event related configurations."
+ },
+ "userData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01."
+ },
+ "capacityReservation": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 0,
+ "description": "Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01."
+ },
+ "applicationProfile": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Specifies the gallery applications that should be made available to the VM/VMSS."
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Low"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/633"
+ },
+ {
+ "$ref": "#/634"
+ },
+ {
+ "$ref": "#/635"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/637"
+ },
+ {
+ "$ref": "#/638"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineInstanceView",
+ "properties": {
+ "platformUpdateDomain": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the update domain of the virtual machine."
+ },
+ "platformFaultDomain": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the fault domain of the virtual machine."
+ },
+ "computerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The computer name assigned to the virtual machine."
+ },
+ "osName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Operating System running on the virtual machine."
+ },
+ "osVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The version of Operating System running on the virtual machine."
+ },
+ "hyperVGeneration": {
+ "type": {
+ "$ref": "#/643"
+ },
+ "flags": 0,
+ "description": "Specifies the HyperVGeneration Type associated with a resource"
+ },
+ "rdpThumbPrint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Remote desktop certificate thumbprint."
+ },
+ "vmAgent": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "The VM Agent running on the virtual machine."
+ },
+ "maintenanceRedeployStatus": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 0,
+ "description": "The Maintenance Operation status on the virtual machine."
+ },
+ "disks": {
+ "type": {
+ "$ref": "#/644"
+ },
+ "flags": 0,
+ "description": "The virtual machine disk information."
+ },
+ "extensions": {
+ "type": {
+ "$ref": "#/645"
+ },
+ "flags": 0,
+ "description": "The extensions information."
+ },
+ "vmHealth": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 2,
+ "description": "The application health status for the VM, provided through Application Health Extension."
+ },
+ "bootDiagnostics": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 0,
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor."
+ },
+ "assignedHost": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/646"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ },
+ "patchStatus": {
+ "type": {
+ "$ref": "#/647"
+ },
+ "flags": 0,
+ "description": "[Preview Feature] The status of virtual machine patch operations."
+ },
+ "isVMInStandbyPool": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/641"
+ },
+ {
+ "$ref": "#/642"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/317"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/292"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachinePatchStatus",
+ "properties": {
+ "availablePatchSummary": {
+ "type": {
+ "$ref": "#/648"
+ },
+ "flags": 0,
+ "description": "The available patch summary of the latest assessment operation for the virtual machine."
+ },
+ "lastPatchInstallationSummary": {
+ "type": {
+ "$ref": "#/659"
+ },
+ "flags": 0,
+ "description": "The installation summary of the latest installation operation for the virtual machine."
+ },
+ "configurationStatuses": {
+ "type": {
+ "$ref": "#/666"
+ },
+ "flags": 2,
+ "description": "The enablement status of the specified patchMode"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AvailablePatchSummary",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/654"
+ },
+ "flags": 2,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\""
+ },
+ "assessmentActivityId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "rebootPending": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred."
+ },
+ "criticalAndSecurityPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of critical or security patches that have been detected as available and not yet installed."
+ },
+ "otherPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of all available patches excluding critical and security."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the operation began."
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the operation began."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/655"
+ },
+ "flags": 2,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/649"
+ },
+ {
+ "$ref": "#/650"
+ },
+ {
+ "$ref": "#/651"
+ },
+ {
+ "$ref": "#/652"
+ },
+ {
+ "$ref": "#/653"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApiError",
+ "properties": {
+ "details": {
+ "type": {
+ "$ref": "#/657"
+ },
+ "flags": 0,
+ "description": "The Api error details"
+ },
+ "innererror": {
+ "type": {
+ "$ref": "#/658"
+ },
+ "flags": 0,
+ "description": "The Api inner error"
+ },
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The error code."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The target of the particular error."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The error message."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApiErrorBase",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The error code."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The target of the particular error."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The error message."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/656"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InnerError",
+ "properties": {
+ "exceptiontype": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The exception type."
+ },
+ "errordetail": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The internal error message or exception dump."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LastPatchInstallationSummary",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/665"
+ },
+ "flags": 2,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\""
+ },
+ "installationActivityId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "maintenanceWindowExceeded": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Describes whether the operation ran out of time before it completed all its intended actions"
+ },
+ "notSelectedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry."
+ },
+ "excludedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of all available patches but excluded explicitly by a customer-specified exclusion list match."
+ },
+ "pendingPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of all available patches expected to be installed over the course of the patch installation operation."
+ },
+ "installedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The count of patches that successfully installed."
+ },
+ "failedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The count of patches that failed installation."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the operation began."
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the operation began."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/655"
+ },
+ "flags": 2,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/660"
+ },
+ {
+ "$ref": "#/661"
+ },
+ {
+ "$ref": "#/662"
+ },
+ {
+ "$ref": "#/663"
+ },
+ {
+ "$ref": "#/664"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/611"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Placement",
+ "properties": {
+ "zonePlacementPolicy": {
+ "type": {
+ "$ref": "#/671"
+ },
+ "flags": 0,
+ "description": "Specifies the policy for virtual machine's placement in availability zone. Possible values are: **Any** - An availability zone will be automatically picked by system as part of virtual machine creation."
+ },
+ "includeZones": {
+ "type": {
+ "$ref": "#/672"
+ },
+ "flags": 0,
+ "description": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection."
+ },
+ "excludeZones": {
+ "type": {
+ "$ref": "#/673"
+ },
+ "flags": 0,
+ "description": "This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Any"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/670"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachines@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/631"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/availabilitySets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/availabilitySets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/676"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/677"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/679"
+ },
+ "flags": 0,
+ "description": "The instance view of a resource."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 0,
+ "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/684"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AvailabilitySetProperties",
+ "properties": {
+ "platformUpdateDomainCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Update Domain count."
+ },
+ "platformFaultDomainCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Fault Domain count."
+ },
+ "virtualMachines": {
+ "type": {
+ "$ref": "#/680"
+ },
+ "flags": 0,
+ "description": "A list of references to all virtual machines in the availability set."
+ },
+ "proximityPlacementGroup": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/681"
+ },
+ "flags": 2,
+ "description": "The resource status information."
+ },
+ "scheduledEventsPolicy": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set."
+ },
+ "virtualMachineScaleSetMigrationInfo": {
+ "type": {
+ "$ref": "#/682"
+ },
+ "flags": 2,
+ "description": "Describes the migration properties on the Availability Set."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetMigrationInfo",
+ "properties": {
+ "defaultVirtualMachineScaleSetInfo": {
+ "type": {
+ "$ref": "#/683"
+ },
+ "flags": 2,
+ "description": "Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API."
+ },
+ "migrateToVirtualMachineScaleSet": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 2,
+ "description": "Specifies the Virtual Machine Scale Set that the Availability Set is migrated to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DefaultVirtualMachineScaleSetInfo",
+ "properties": {
+ "constrainedMaximumCapacity": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs."
+ },
+ "defaultVirtualMachineScaleSet": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 2,
+ "description": "The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/availabilitySets@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/678"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/proximityPlacementGroups"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/proximityPlacementGroups",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/686"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/687"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/689"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Proximity Placement Group."
+ },
+ "zones": {
+ "type": {
+ "$ref": "#/699"
+ },
+ "flags": 0,
+ "description": "Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/700"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProximityPlacementGroupProperties",
+ "properties": {
+ "proximityPlacementGroupType": {
+ "type": {
+ "$ref": "#/692"
+ },
+ "flags": 0,
+ "description": "Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use."
+ },
+ "virtualMachines": {
+ "type": {
+ "$ref": "#/694"
+ },
+ "flags": 2,
+ "description": "A list of references to all virtual machines in the proximity placement group."
+ },
+ "virtualMachineScaleSets": {
+ "type": {
+ "$ref": "#/695"
+ },
+ "flags": 2,
+ "description": "A list of references to all virtual machine scale sets in the proximity placement group."
+ },
+ "availabilitySets": {
+ "type": {
+ "$ref": "#/696"
+ },
+ "flags": 2,
+ "description": "A list of references to all availability sets in the proximity placement group."
+ },
+ "colocationStatus": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "Describes colocation status of the Proximity Placement Group."
+ },
+ "intent": {
+ "type": {
+ "$ref": "#/697"
+ },
+ "flags": 0,
+ "description": "Specifies the user intent of the proximity placement group."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ultra"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/690"
+ },
+ {
+ "$ref": "#/691"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubResourceWithColocationStatus",
+ "properties": {
+ "colocationStatus": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "Describes colocation status of a resource in the Proximity Placement Group."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/693"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/693"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/693"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProximityPlacementGroupPropertiesIntent",
+ "properties": {
+ "vmSizes": {
+ "type": {
+ "$ref": "#/698"
+ },
+ "flags": 0,
+ "description": "Specifies possible sizes of virtual machines that can be created in the proximity placement group."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/proximityPlacementGroups@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/688"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/hostGroups"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/hostGroups",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/702"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/703"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/705"
+ },
+ "flags": 0,
+ "description": "Dedicated Host Group Properties."
+ },
+ "zones": {
+ "type": {
+ "$ref": "#/717"
+ },
+ "flags": 0,
+ "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/718"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostGroupProperties",
+ "properties": {
+ "platformFaultDomainCount": {
+ "type": {
+ "$ref": "#/706"
+ },
+ "flags": 1,
+ "description": "Number of fault domains that the host group can span."
+ },
+ "hosts": {
+ "type": {
+ "$ref": "#/708"
+ },
+ "flags": 2,
+ "description": "A list of references to all dedicated hosts in the dedicated host group."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/709"
+ },
+ "flags": 2,
+ "description": "The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group."
+ },
+ "supportAutomaticPlacement": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01."
+ },
+ "additionalCapabilities": {
+ "type": {
+ "$ref": "#/716"
+ },
+ "flags": 0,
+ "description": "Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubResourceReadOnly",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostGroupInstanceView",
+ "properties": {
+ "hosts": {
+ "type": {
+ "$ref": "#/715"
+ },
+ "flags": 0,
+ "description": "List of instance view of the dedicated hosts under the dedicated host group."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostInstanceViewWithName",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the dedicated host."
+ },
+ "assetId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides."
+ },
+ "availableCapacity": {
+ "type": {
+ "$ref": "#/711"
+ },
+ "flags": 0,
+ "description": "Unutilized capacity of the dedicated host."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/714"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostAvailableCapacity",
+ "properties": {
+ "allocatableVMs": {
+ "type": {
+ "$ref": "#/713"
+ },
+ "flags": 0,
+ "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostAllocatableVM",
+ "properties": {
+ "vmSize": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "VM size in terms of which the unutilized capacity is represented."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/712"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/710"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostGroupPropertiesAdditionalCapabilities",
+ "properties": {
+ "ultraSSDEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/hostGroups@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/704"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/hostGroups/hosts"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/hostGroups/hosts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/720"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/721"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/723"
+ },
+ "flags": 0,
+ "description": "Properties of the dedicated host."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 1,
+ "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/731"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostProperties",
+ "properties": {
+ "platformFaultDomain": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 0,
+ "description": "Fault domain of the dedicated host within a dedicated host group."
+ },
+ "autoReplaceOnFailure": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided."
+ },
+ "hostId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host."
+ },
+ "virtualMachines": {
+ "type": {
+ "$ref": "#/724"
+ },
+ "flags": 2,
+ "description": "A list of references to all virtual machines in the Dedicated Host."
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/728"
+ },
+ "flags": 0,
+ "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**"
+ },
+ "provisioningTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The date when the host was first provisioned."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/729"
+ },
+ "flags": 2,
+ "description": "The dedicated host instance view."
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows_Server_Hybrid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows_Server_Perpetual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/725"
+ },
+ {
+ "$ref": "#/726"
+ },
+ {
+ "$ref": "#/727"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DedicatedHostInstanceView",
+ "properties": {
+ "assetId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides."
+ },
+ "availableCapacity": {
+ "type": {
+ "$ref": "#/711"
+ },
+ "flags": 0,
+ "description": "Unutilized capacity of the dedicated host."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/730"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/hostGroups/hosts@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/722"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/sshPublicKeys"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/sshPublicKeys",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/733"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/734"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/736"
+ },
+ "flags": 0,
+ "description": "Properties of the SSH public key."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/737"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SshPublicKeyResourceProperties",
+ "properties": {
+ "publicKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/sshPublicKeys@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/735"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/images"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/images",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/739"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/740"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/742"
+ },
+ "flags": 0,
+ "description": "Describes the properties of an Image."
+ },
+ "extendedLocation": {
+ "type": {
+ "$ref": "#/279"
+ },
+ "flags": 0,
+ "description": "The extended location of the Image."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/780"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageProperties",
+ "properties": {
+ "sourceVirtualMachine": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The source virtual machine from which Image is created."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/743"
+ },
+ "flags": 0,
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state."
+ },
+ "hyperVGeneration": {
+ "type": {
+ "$ref": "#/779"
+ },
+ "flags": 0,
+ "description": "Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageStorageProfile",
+ "properties": {
+ "osDisk": {
+ "type": {
+ "$ref": "#/744"
+ },
+ "flags": 0,
+ "description": "Specifies information about the operating system disk used by the virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "dataDisks": {
+ "type": {
+ "$ref": "#/776"
+ },
+ "flags": 0,
+ "description": "Specifies the parameters that are used to add a data disk to a virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "zoneResilient": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageOSDisk",
+ "properties": {
+ "osType": {
+ "type": {
+ "$ref": "#/747"
+ },
+ "flags": 1,
+ "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.**"
+ },
+ "osState": {
+ "type": {
+ "$ref": "#/750"
+ },
+ "flags": 1,
+ "description": "The OS State. For managed images, use Generalized."
+ },
+ "snapshot": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The snapshot."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The managedDisk."
+ },
+ "blobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Virtual Hard Disk."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/754"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB."
+ },
+ "storageAccountType": {
+ "type": {
+ "$ref": "#/762"
+ },
+ "flags": 0,
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Specifies the customer managed disk encryption set resource id for the managed image disk."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/745"
+ },
+ {
+ "$ref": "#/746"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Generalized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Specialized"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/748"
+ },
+ {
+ "$ref": "#/749"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/751"
+ },
+ {
+ "$ref": "#/752"
+ },
+ {
+ "$ref": "#/753"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UltraSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PremiumV2_LRS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/755"
+ },
+ {
+ "$ref": "#/756"
+ },
+ {
+ "$ref": "#/757"
+ },
+ {
+ "$ref": "#/758"
+ },
+ {
+ "$ref": "#/759"
+ },
+ {
+ "$ref": "#/760"
+ },
+ {
+ "$ref": "#/761"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageDataDisk",
+ "properties": {
+ "lun": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 1,
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ },
+ "snapshot": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The snapshot."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The managedDisk."
+ },
+ "blobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Virtual Hard Disk."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/767"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB."
+ },
+ "storageAccountType": {
+ "type": {
+ "$ref": "#/775"
+ },
+ "flags": 0,
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Specifies the customer managed disk encryption set resource id for the managed image disk."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/764"
+ },
+ {
+ "$ref": "#/765"
+ },
+ {
+ "$ref": "#/766"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UltraSSD_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_ZRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PremiumV2_LRS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/768"
+ },
+ {
+ "$ref": "#/769"
+ },
+ {
+ "$ref": "#/770"
+ },
+ {
+ "$ref": "#/771"
+ },
+ {
+ "$ref": "#/772"
+ },
+ {
+ "$ref": "#/773"
+ },
+ {
+ "$ref": "#/774"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/763"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/777"
+ },
+ {
+ "$ref": "#/778"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/images@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/741"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/restorePointCollections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/restorePointCollections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/782"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/783"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/785"
+ },
+ "flags": 0,
+ "description": "The restore point collection properties."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/828"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointCollectionProperties",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/786"
+ },
+ "flags": 0,
+ "description": "The properties of the source resource that this restore point collection is created from."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the restore point collection."
+ },
+ "restorePointCollectionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique id of the restore point collection."
+ },
+ "restorePoints": {
+ "type": {
+ "$ref": "#/827"
+ },
+ "flags": 2,
+ "description": "A list containing all restore points created under this restore point collection."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointCollectionSourceProperties",
+ "properties": {
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Location of the source resource used to create this restore point collection."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id of the source resource used to create this restore point collection"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePoint",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/788"
+ },
+ "flags": 0,
+ "description": "The restore point properties."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointProperties",
+ "properties": {
+ "excludeDisks": {
+ "type": {
+ "$ref": "#/789"
+ },
+ "flags": 0,
+ "description": "List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included."
+ },
+ "sourceMetadata": {
+ "type": {
+ "$ref": "#/790"
+ },
+ "flags": 0,
+ "description": "Gets the details of the VM captured at the time of the restore point creation."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Gets the provisioning state of the restore point."
+ },
+ "consistencyMode": {
+ "type": {
+ "$ref": "#/821"
+ },
+ "flags": 0,
+ "description": "ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details."
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets the creation time of the restore point."
+ },
+ "sourceRestorePoint": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Resource Id of the source restore point from which a copy needs to be created."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/822"
+ },
+ "flags": 2,
+ "description": "The restore point instance view."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/140"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointSourceMetadata",
+ "properties": {
+ "hardwareProfile": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 2,
+ "description": "Gets the hardware profile."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/791"
+ },
+ "flags": 0,
+ "description": "Gets the storage profile."
+ },
+ "osProfile": {
+ "type": {
+ "$ref": "#/550"
+ },
+ "flags": 2,
+ "description": "Gets the OS profile."
+ },
+ "diagnosticsProfile": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 2,
+ "description": "Gets the diagnostics profile."
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Gets the license type, which is for bring your own license scenario."
+ },
+ "vmId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Gets the virtual machine unique id."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 2,
+ "description": "Gets the security profile."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Location of the VM from which the restore point was created."
+ },
+ "userData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value."
+ },
+ "hyperVGeneration": {
+ "type": {
+ "$ref": "#/817"
+ },
+ "flags": 2,
+ "description": "HyperVGeneration of the source VM for which restore point is captured."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointSourceVMStorageProfile",
+ "properties": {
+ "osDisk": {
+ "type": {
+ "$ref": "#/792"
+ },
+ "flags": 0,
+ "description": "Gets the OS disk of the VM captured at the time of the restore point creation."
+ },
+ "dataDisks": {
+ "type": {
+ "$ref": "#/811"
+ },
+ "flags": 0,
+ "description": "Gets the data disks of the VM captured at the time of the restore point creation."
+ },
+ "diskControllerType": {
+ "type": {
+ "$ref": "#/814"
+ },
+ "flags": 2,
+ "description": "Gets the disk controller type of the VM captured at the time of the restore point creation."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointSourceVmosDisk",
+ "properties": {
+ "osType": {
+ "type": {
+ "$ref": "#/795"
+ },
+ "flags": 2,
+ "description": "Gets the Operating System type."
+ },
+ "encryptionSettings": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 2,
+ "description": "Gets the disk encryption settings."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Gets the disk name."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/799"
+ },
+ "flags": 2,
+ "description": "Gets the caching type."
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "Gets the disk size in GB."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "Gets the managed disk details"
+ },
+ "diskRestorePoint": {
+ "type": {
+ "$ref": "#/800"
+ },
+ "flags": 0,
+ "description": "Contains Disk Restore Point properties."
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Shows true if the disk is write-accelerator enabled."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/793"
+ },
+ {
+ "$ref": "#/794"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/796"
+ },
+ {
+ "$ref": "#/797"
+ },
+ {
+ "$ref": "#/798"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskRestorePointAttributes",
+ "properties": {
+ "encryption": {
+ "type": {
+ "$ref": "#/801"
+ },
+ "flags": 0,
+ "description": "Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point."
+ },
+ "sourceDiskRestorePoint": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Resource Id of the source disk restore point."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointEncryption",
+ "properties": {
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/805"
+ },
+ "flags": 0,
+ "description": "The type of key used to encrypt the data of the disk restore point."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EncryptionAtRestWithPlatformKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EncryptionAtRestWithCustomerKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EncryptionAtRestWithPlatformAndCustomerKeys"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/802"
+ },
+ {
+ "$ref": "#/803"
+ },
+ {
+ "$ref": "#/804"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointSourceVMDataDisk",
+ "properties": {
+ "lun": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "Gets the logical unit number."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Gets the disk name."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/810"
+ },
+ "flags": 2,
+ "description": "Gets the caching type."
+ },
+ "diskSizeGB": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "Contains the managed disk details."
+ },
+ "diskRestorePoint": {
+ "type": {
+ "$ref": "#/800"
+ },
+ "flags": 0,
+ "description": "Contains Disk Restore Point properties."
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Shows true if the disk is write-accelerator enabled."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/807"
+ },
+ {
+ "$ref": "#/808"
+ },
+ {
+ "$ref": "#/809"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/806"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SCSI"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NVMe"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/812"
+ },
+ {
+ "$ref": "#/813"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "V2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/815"
+ },
+ {
+ "$ref": "#/816"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CrashConsistent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FileSystemConsistent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ApplicationConsistent"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/818"
+ },
+ {
+ "$ref": "#/819"
+ },
+ {
+ "$ref": "#/820"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorePointInstanceView",
+ "properties": {
+ "diskRestorePoints": {
+ "type": {
+ "$ref": "#/825"
+ },
+ "flags": 0,
+ "description": "The disk restore points information."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/826"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskRestorePointInstanceView",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Disk restore point Id."
+ },
+ "replicationStatus": {
+ "type": {
+ "$ref": "#/824"
+ },
+ "flags": 0,
+ "description": "The disk restore point replication status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskRestorePointReplicationStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ },
+ "completionPercent": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Replication completion percentage."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/823"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/787"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/restorePointCollections@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/784"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/restorePointCollections/restorePoints"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/restorePointCollections/restorePoints",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/830"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/831"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/788"
+ },
+ "flags": 0,
+ "description": "The restore point properties."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/restorePointCollections/restorePoints@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/832"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/capacityReservationGroups"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/capacityReservationGroups",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/834"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/835"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/837"
+ },
+ "flags": 0,
+ "description": "capacity reservation group Properties."
+ },
+ "zones": {
+ "type": {
+ "$ref": "#/849"
+ },
+ "flags": 0,
+ "description": "Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/850"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationGroupProperties",
+ "properties": {
+ "capacityReservations": {
+ "type": {
+ "$ref": "#/838"
+ },
+ "flags": 2,
+ "description": "A list of all capacity reservation resource ids that belong to capacity reservation group."
+ },
+ "virtualMachinesAssociated": {
+ "type": {
+ "$ref": "#/839"
+ },
+ "flags": 2,
+ "description": "A list of references to all virtual machines associated to the capacity reservation group."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/840"
+ },
+ "flags": 2,
+ "description": "The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group."
+ },
+ "sharingProfile": {
+ "type": {
+ "$ref": "#/847"
+ },
+ "flags": 0,
+ "description": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationGroupInstanceView",
+ "properties": {
+ "capacityReservations": {
+ "type": {
+ "$ref": "#/845"
+ },
+ "flags": 2,
+ "description": "List of instance view of the capacity reservations under the capacity reservation group."
+ },
+ "sharedSubscriptionIds": {
+ "type": {
+ "$ref": "#/846"
+ },
+ "flags": 2,
+ "description": "List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationInstanceViewWithName",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the capacity reservation."
+ },
+ "utilizationInfo": {
+ "type": {
+ "$ref": "#/842"
+ },
+ "flags": 0,
+ "description": "Unutilized capacity of the capacity reservation."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/844"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationUtilization",
+ "properties": {
+ "currentCapacity": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01."
+ },
+ "virtualMachinesAllocated": {
+ "type": {
+ "$ref": "#/843"
+ },
+ "flags": 2,
+ "description": "A list of all virtual machines resource ids allocated against the capacity reservation."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/841"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceSharingProfile",
+ "properties": {
+ "subscriptionIds": {
+ "type": {
+ "$ref": "#/848"
+ },
+ "flags": 0,
+ "description": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/77"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/capacityReservationGroups@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/836"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/capacityReservationGroups/capacityReservations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/capacityReservationGroups/capacityReservations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/852"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/853"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/855"
+ },
+ "flags": 0,
+ "description": "Properties of the Capacity reservation."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 1,
+ "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values."
+ },
+ "zones": {
+ "type": {
+ "$ref": "#/859"
+ },
+ "flags": 0,
+ "description": "Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/860"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationProperties",
+ "properties": {
+ "reservationId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource."
+ },
+ "platformFaultDomainCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01."
+ },
+ "virtualMachinesAssociated": {
+ "type": {
+ "$ref": "#/856"
+ },
+ "flags": 2,
+ "description": "A list of all virtual machine resource ids that are associated with the capacity reservation."
+ },
+ "provisioningTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The date time when the capacity reservation was last updated."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/857"
+ },
+ "flags": 2,
+ "description": "The Capacity reservation instance view."
+ },
+ "timeCreated": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/707"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityReservationInstanceView",
+ "properties": {
+ "utilizationInfo": {
+ "type": {
+ "$ref": "#/842"
+ },
+ "flags": 0,
+ "description": "Unutilized capacity of the capacity reservation."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/858"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/capacityReservationGroups/capacityReservations@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/854"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachines/runCommands"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachines/runCommands",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/862"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/863"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/865"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine run command."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/881"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineRunCommandProperties",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/866"
+ },
+ "flags": 0,
+ "description": "The source of the run command script."
+ },
+ "parameters": {
+ "type": {
+ "$ref": "#/869"
+ },
+ "flags": 0,
+ "description": "The parameters used by the script."
+ },
+ "protectedParameters": {
+ "type": {
+ "$ref": "#/870"
+ },
+ "flags": 0,
+ "description": "The parameters used by the script."
+ },
+ "asyncExecution": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete."
+ },
+ "runAsUser": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the user account on the VM when executing the run command."
+ },
+ "runAsPassword": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the user account password on the VM when executing the run command."
+ },
+ "timeoutInSeconds": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The timeout in seconds to execute the run command."
+ },
+ "outputBlobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter."
+ },
+ "errorBlobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter."
+ },
+ "outputBlobManagedIdentity": {
+ "type": {
+ "$ref": "#/867"
+ },
+ "flags": 0,
+ "description": "User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged"
+ },
+ "errorBlobManagedIdentity": {
+ "type": {
+ "$ref": "#/867"
+ },
+ "flags": 0,
+ "description": "User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results"
+ },
+ "instanceView": {
+ "type": {
+ "$ref": "#/871"
+ },
+ "flags": 2,
+ "description": "The virtual machine run command instance view."
+ },
+ "treatFailureAsDeploymentFailure": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineRunCommandScriptSource",
+ "properties": {
+ "script": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the script content to be executed on the VM."
+ },
+ "scriptUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI."
+ },
+ "commandId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies a commandId of predefined built-in script."
+ },
+ "scriptUriManagedIdentity": {
+ "type": {
+ "$ref": "#/867"
+ },
+ "flags": 0,
+ "description": "User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandManagedIdentity",
+ "properties": {
+ "clientId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandInputParameter",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The run command parameter name."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The run command parameter value."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/868"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/868"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineRunCommandInstanceView",
+ "properties": {
+ "executionState": {
+ "type": {
+ "$ref": "#/879"
+ },
+ "flags": 0,
+ "description": "Script execution status."
+ },
+ "executionMessage": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Communicate script configuration errors or execution messages."
+ },
+ "exitCode": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Exit code returned from script execution."
+ },
+ "output": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Script output stream."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Script error stream."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Script start time."
+ },
+ "endTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Script end time."
+ },
+ "statuses": {
+ "type": {
+ "$ref": "#/880"
+ },
+ "flags": 0,
+ "description": "The resource status information."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TimedOut"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/872"
+ },
+ {
+ "$ref": "#/873"
+ },
+ {
+ "$ref": "#/874"
+ },
+ {
+ "$ref": "#/875"
+ },
+ {
+ "$ref": "#/876"
+ },
+ {
+ "$ref": "#/877"
+ },
+ {
+ "$ref": "#/878"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachines/runCommands@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/864"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/883"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/884"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/865"
+ },
+ "flags": 0,
+ "description": "Describes the properties of a Virtual Machine run command."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/886"
+ },
+ "flags": 0,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/885"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "latest"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/virtualMachineScaleSets/rollingUpgrades"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/rollingUpgrades",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/888"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/889"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/890"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/892"
+ },
+ "flags": 2,
+ "description": "The status of the latest virtual machine scale set rolling upgrade."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/903"
+ },
+ "flags": 2,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RollingUpgradeStatusInfoProperties",
+ "properties": {
+ "policy": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "The rolling upgrade policies applied for this upgrade."
+ },
+ "runningStatus": {
+ "type": {
+ "$ref": "#/893"
+ },
+ "flags": 2,
+ "description": "Information about the current running state of the overall upgrade."
+ },
+ "progress": {
+ "type": {
+ "$ref": "#/902"
+ },
+ "flags": 2,
+ "description": "Information about the number of virtual machine instances in each upgrade state."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/655"
+ },
+ "flags": 2,
+ "description": "Error details for this upgrade, if there are any."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RollingUpgradeRunningStatus",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/898"
+ },
+ "flags": 2,
+ "description": "Code indicating the current status of the upgrade."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Start time of the upgrade."
+ },
+ "lastAction": {
+ "type": {
+ "$ref": "#/901"
+ },
+ "flags": 2,
+ "description": "The last action performed on the rolling upgrade."
+ },
+ "lastActionTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Last action time of the upgrade."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RollingForward"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cancelled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Faulted"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/894"
+ },
+ {
+ "$ref": "#/895"
+ },
+ {
+ "$ref": "#/896"
+ },
+ {
+ "$ref": "#/897"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Start"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cancel"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/899"
+ },
+ {
+ "$ref": "#/900"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RollingUpgradeProgressInfo",
+ "properties": {
+ "successfulInstanceCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of instances that have been successfully upgraded."
+ },
+ "failedInstanceCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of instances that have failed to be upgraded successfully."
+ },
+ "inProgressInstanceCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of instances that are currently being upgraded."
+ },
+ "pendingInstanceCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of instances that have not yet begun to be upgraded."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/virtualMachineScaleSets/rollingUpgrades@2024-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/891"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Compute/locations/publishers/artifacttypes/types/versions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Compute/locations/publishers/artifacttypes/types/versions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/905"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/906"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/908"
+ },
+ "flags": 2,
+ "description": "Describes the properties of a Virtual Machine Extension Image."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource location"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/909"
+ },
+ "flags": 2,
+ "description": "Resource tags"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineExtensionImageProperties",
+ "properties": {
+ "operatingSystem": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The operating system this extension supports."
+ },
+ "computeRole": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The type of role (IaaS or PaaS) this extension supports."
+ },
+ "handlerSchema": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema."
+ },
+ "vmScaleSetEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS."
+ },
+ "supportsMultipleExtensions": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether the handler can support multiple extensions."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Compute/locations/publishers/artifacttypes/types/versions@2024-11-01",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/907"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMInstanceIDs",
+ "properties": {
+ "instanceIds": {
+ "type": {
+ "$ref": "#/912"
+ },
+ "flags": 0,
+ "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deallocate",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMInstanceRequiredIDs",
+ "properties": {
+ "instanceIds": {
+ "type": {
+ "$ref": "#/915"
+ },
+ "flags": 1,
+ "description": "The virtual machine scale set instance ids."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "delete",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/914"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "poweroff",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "restart",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reapply",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redeploy",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "performMaintenance",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "manualupgrade",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/914"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetReimageParameters",
+ "properties": {
+ "instanceIds": {
+ "type": {
+ "$ref": "#/925"
+ },
+ "flags": 0,
+ "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set."
+ },
+ "forceUpdateOSDiskForEphemeral": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Parameter to force update ephemeral OS disk for a virtual machine scale set VM"
+ },
+ "tempDisk": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
+ },
+ "exactVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk."
+ },
+ "osProfile": {
+ "type": {
+ "$ref": "#/926"
+ },
+ "flags": 0,
+ "description": "Specifies information required for reimaging the non-ephemeral OS disk."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OSProfileProvisioningData",
+ "properties": {
+ "adminPassword": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)"
+ },
+ "customData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). If using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reimage",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/924"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reimageall",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "approveRollingUpgrade",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/911"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VMScaleSetConvertToSinglePlacementGroupInput",
+ "properties": {
+ "activePlacementGroupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "convertToSinglePlacementGroup",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/930"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OrchestrationServiceStateInput",
+ "properties": {
+ "serviceName": {
+ "type": {
+ "$ref": "#/934"
+ },
+ "flags": 1,
+ "description": "The name of the service."
+ },
+ "action": {
+ "type": {
+ "$ref": "#/937"
+ },
+ "flags": 1,
+ "description": "The action to be performed."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutomaticRepairs"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/933"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Resume"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Suspend"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/935"
+ },
+ {
+ "$ref": "#/936"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "setOrchestrationServiceState",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/932"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "osRollingUpgrade",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "extensionRollingUpgrade",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineScaleSetVMReimageParameters",
+ "properties": {
+ "forceUpdateOSDiskForEphemeral": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Parameter to force update ephemeral OS disk for a virtual machine scale set VM"
+ },
+ "tempDisk": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
+ },
+ "exactVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk."
+ },
+ "osProfile": {
+ "type": {
+ "$ref": "#/926"
+ },
+ "flags": 0,
+ "description": "Specifies information required for reimaging the non-ephemeral OS disk."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reimage",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/941"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reimageall",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "approveRollingUpgrade",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deallocate",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "poweroff",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "restart",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redeploy",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetrieveBootDiagnosticsDataResult",
+ "properties": {
+ "consoleScreenshotBlobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The console screenshot blob URI"
+ },
+ "serialConsoleLogBlobUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The serial console log blob URI."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveBootDiagnosticsData",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/950"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "performMaintenance",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "simulateEviction",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AttachDetachDataDisksRequest",
+ "properties": {
+ "dataDisksToAttach": {
+ "type": {
+ "$ref": "#/963"
+ },
+ "flags": 0,
+ "description": "The list of managed data disks to be attached."
+ },
+ "dataDisksToDetach": {
+ "type": {
+ "$ref": "#/967"
+ },
+ "flags": 0,
+ "description": "The list of managed data disks to be detached."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataDisksToAttach",
+ "properties": {
+ "diskId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "ID of the managed data disk."
+ },
+ "lun": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. If not specified, lun would be auto assigned."
+ },
+ "caching": {
+ "type": {
+ "$ref": "#/959"
+ },
+ "flags": 0,
+ "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**"
+ },
+ "deleteOption": {
+ "type": {
+ "$ref": "#/962"
+ },
+ "flags": 0,
+ "description": "Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**."
+ },
+ "diskEncryptionSet": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk."
+ },
+ "writeAcceleratorEnabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/956"
+ },
+ {
+ "$ref": "#/957"
+ },
+ {
+ "$ref": "#/958"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Detach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/960"
+ },
+ {
+ "$ref": "#/961"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/955"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataDisksToDetach",
+ "properties": {
+ "diskId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "ID of the managed data disk."
+ },
+ "detachOption": {
+ "type": {
+ "$ref": "#/966"
+ },
+ "flags": 0,
+ "description": "Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForceDetach"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/965"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/964"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "attachDetachDataDisks",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/503"
+ },
+ "input": {
+ "$ref": "#/954"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandInput",
+ "properties": {
+ "commandId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The run command id."
+ },
+ "script": {
+ "type": {
+ "$ref": "#/970"
+ },
+ "flags": 0,
+ "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command."
+ },
+ "parameters": {
+ "type": {
+ "$ref": "#/971"
+ },
+ "flags": 0,
+ "description": "The run command parameters."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/868"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandResult",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/973"
+ },
+ "flags": 0,
+ "description": "Run command operation response."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "runCommand",
+ "resourceType": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/972"
+ },
+ "input": {
+ "$ref": "#/969"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineCaptureParameters",
+ "properties": {
+ "vhdPrefix": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The captured virtual hard disk's name prefix."
+ },
+ "destinationContainerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The destination container name."
+ },
+ "overwriteVhds": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 1,
+ "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineCaptureResult",
+ "properties": {
+ "$schema": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "the schema of the captured virtual machine"
+ },
+ "contentVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "the version of the content"
+ },
+ "parameters": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 2,
+ "description": "parameters of the captured virtual machine"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/977"
+ },
+ "flags": 2,
+ "description": "a list of resource items of the captured virtual machine"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Id"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/215"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "capture",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/976"
+ },
+ "input": {
+ "$ref": "#/975"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "convertToManagedDisks",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deallocate",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "generalize",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "powerOff",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reapply",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "restart",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redeploy",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineReimageParameters",
+ "properties": {
+ "tempDisk": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
+ },
+ "exactVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk."
+ },
+ "osProfile": {
+ "type": {
+ "$ref": "#/926"
+ },
+ "flags": 0,
+ "description": "Specifies information required for reimaging the non-ephemeral OS disk."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reimage",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/987"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveBootDiagnosticsData",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/950"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "performMaintenance",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "simulateEviction",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineAssessPatchesResult",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/998"
+ },
+ "flags": 2,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\""
+ },
+ "assessmentActivityId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "rebootPending": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred."
+ },
+ "criticalAndSecurityPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of critical or security patches that have been detected as available and not yet installed."
+ },
+ "otherPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of all available patches excluding critical and security."
+ },
+ "startDateTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the operation began."
+ },
+ "availablePatches": {
+ "type": {
+ "$ref": "#/1009"
+ },
+ "flags": 2,
+ "description": "The list of patches that have been detected as available for installation."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/655"
+ },
+ "flags": 2,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/993"
+ },
+ {
+ "$ref": "#/994"
+ },
+ {
+ "$ref": "#/995"
+ },
+ {
+ "$ref": "#/996"
+ },
+ {
+ "$ref": "#/997"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineSoftwarePatchProperties",
+ "properties": {
+ "patchId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A unique identifier for the patch."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The friendly name of the patch."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The version number of the patch. This property applies only to Linux patches."
+ },
+ "kbId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The KBID of the patch. Only applies to Windows patches."
+ },
+ "classifications": {
+ "type": {
+ "$ref": "#/1000"
+ },
+ "flags": 2,
+ "description": "The classification(s) of the patch as provided by the patch publisher."
+ },
+ "rebootBehavior": {
+ "type": {
+ "$ref": "#/1005"
+ },
+ "flags": 2,
+ "description": "Describes the reboot requirements of the patch."
+ },
+ "activityId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "publishedDate": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the repository published this patch."
+ },
+ "lastModifiedDateTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp of the last update to this patch record."
+ },
+ "assessmentState": {
+ "type": {
+ "$ref": "#/1008"
+ },
+ "flags": 2,
+ "description": "Describes the availability of a given patch."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NeverReboots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AlwaysRequiresReboot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CanRequestReboot"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1001"
+ },
+ {
+ "$ref": "#/1002"
+ },
+ {
+ "$ref": "#/1003"
+ },
+ {
+ "$ref": "#/1004"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Available"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1006"
+ },
+ {
+ "$ref": "#/1007"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/999"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "assessPatches",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/992"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineInstallPatchesParameters",
+ "properties": {
+ "maximumDuration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)"
+ },
+ "rebootSetting": {
+ "type": {
+ "$ref": "#/1015"
+ },
+ "flags": 1,
+ "description": "Defines when it is acceptable to reboot a VM during a software update operation."
+ },
+ "windowsParameters": {
+ "type": {
+ "$ref": "#/1016"
+ },
+ "flags": 0,
+ "description": "Input for InstallPatches on a Windows VM, as directly received by the API"
+ },
+ "linuxParameters": {
+ "type": {
+ "$ref": "#/1029"
+ },
+ "flags": 0,
+ "description": "Input for InstallPatches on a Linux VM, as directly received by the API"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IfRequired"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Never"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Always"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1012"
+ },
+ {
+ "$ref": "#/1013"
+ },
+ {
+ "$ref": "#/1014"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsParameters",
+ "properties": {
+ "classificationsToInclude": {
+ "type": {
+ "$ref": "#/1026"
+ },
+ "flags": 0,
+ "description": "The update classifications to select when installing patches for Windows."
+ },
+ "kbNumbersToInclude": {
+ "type": {
+ "$ref": "#/1027"
+ },
+ "flags": 0,
+ "description": "Kbs to include in the patch operation"
+ },
+ "kbNumbersToExclude": {
+ "type": {
+ "$ref": "#/1028"
+ },
+ "flags": 0,
+ "description": "Kbs to exclude in the patch operation"
+ },
+ "excludeKbsRequiringReboot": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true."
+ },
+ "maxPatchPublishDate": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "This is used to install patches that were published on or before this given max published date."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Critical"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Security"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UpdateRollUp"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FeaturePack"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ServicePack"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Definition"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updates"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1017"
+ },
+ {
+ "$ref": "#/1018"
+ },
+ {
+ "$ref": "#/1019"
+ },
+ {
+ "$ref": "#/1020"
+ },
+ {
+ "$ref": "#/1021"
+ },
+ {
+ "$ref": "#/1022"
+ },
+ {
+ "$ref": "#/1023"
+ },
+ {
+ "$ref": "#/1024"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1025"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxParameters",
+ "properties": {
+ "classificationsToInclude": {
+ "type": {
+ "$ref": "#/1034"
+ },
+ "flags": 0,
+ "description": "The update classifications to select when installing patches for Linux."
+ },
+ "packageNameMasksToInclude": {
+ "type": {
+ "$ref": "#/1035"
+ },
+ "flags": 0,
+ "description": "packages to include in the patch operation. Format: packageName_packageVersion"
+ },
+ "packageNameMasksToExclude": {
+ "type": {
+ "$ref": "#/1036"
+ },
+ "flags": 0,
+ "description": "packages to exclude in the patch operation. Format: packageName_packageVersion"
+ },
+ "maintenanceRunId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "This is used as a maintenance run identifier for Auto VM Guest Patching in Linux."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Critical"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Security"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Other"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1030"
+ },
+ {
+ "$ref": "#/1031"
+ },
+ {
+ "$ref": "#/1032"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1033"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineInstallPatchesResult",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/1043"
+ },
+ "flags": 2,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\""
+ },
+ "installationActivityId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "rebootStatus": {
+ "type": {
+ "$ref": "#/1050"
+ },
+ "flags": 2,
+ "description": "The reboot state of the VM following completion of the operation."
+ },
+ "maintenanceWindowExceeded": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Whether the operation ran out of time before it completed all its intended actions."
+ },
+ "excludedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of patches that were not installed due to the user blocking their installation."
+ },
+ "notSelectedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria."
+ },
+ "pendingPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true."
+ },
+ "installedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of patches successfully installed."
+ },
+ "failedPatchCount": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 2,
+ "description": "The number of patches that could not be installed due to some issue. See errors for details."
+ },
+ "patches": {
+ "type": {
+ "$ref": "#/1060"
+ },
+ "flags": 2,
+ "description": "The patches that were installed during the operation."
+ },
+ "startDateTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The UTC timestamp when the operation began."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/655"
+ },
+ "flags": 2,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1038"
+ },
+ {
+ "$ref": "#/1039"
+ },
+ {
+ "$ref": "#/1040"
+ },
+ {
+ "$ref": "#/1041"
+ },
+ {
+ "$ref": "#/1042"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotNeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Required"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Started"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1044"
+ },
+ {
+ "$ref": "#/1045"
+ },
+ {
+ "$ref": "#/1046"
+ },
+ {
+ "$ref": "#/1047"
+ },
+ {
+ "$ref": "#/1048"
+ },
+ {
+ "$ref": "#/1049"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PatchInstallationDetail",
+ "properties": {
+ "patchId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A unique identifier for the patch."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The friendly name of the patch."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The version string of the package. It may conform to Semantic Versioning. Only applies to Linux."
+ },
+ "kbId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The KBID of the patch. Only applies to Windows patches."
+ },
+ "classifications": {
+ "type": {
+ "$ref": "#/1052"
+ },
+ "flags": 2,
+ "description": "The classification(s) of the patch as provided by the patch publisher."
+ },
+ "installationState": {
+ "type": {
+ "$ref": "#/1059"
+ },
+ "flags": 2,
+ "description": "The state of the patch after the installation operation completed."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Installed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Excluded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotSelected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1053"
+ },
+ {
+ "$ref": "#/1054"
+ },
+ {
+ "$ref": "#/1055"
+ },
+ {
+ "$ref": "#/1056"
+ },
+ {
+ "$ref": "#/1057"
+ },
+ {
+ "$ref": "#/1058"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1051"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "installPatches",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/1037"
+ },
+ "input": {
+ "$ref": "#/1011"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "attachDetachDataDisks",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/503"
+ },
+ "input": {
+ "$ref": "#/954"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateVMToVirtualMachineScaleSetInput",
+ "properties": {
+ "targetZone": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The target zone of VM migration to Flexible Virtual Machine Scale Set."
+ },
+ "targetFaultDomain": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The target compute fault domain of VM migration to Flexible Virtual Machine Scale Set."
+ },
+ "targetVMSize": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The target Virtual Machine size of VM migration to Flexible Virtual Machine Scale Set."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToVirtualMachineScaleSet",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/1063"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "runCommand",
+ "resourceType": "Microsoft.Compute/virtualMachines",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/972"
+ },
+ "input": {
+ "$ref": "#/969"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateToVirtualMachineScaleSetInput",
+ "properties": {
+ "virtualMachineScaleSetFlexible": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 1,
+ "description": "Specifies information about the Virtual Machine Scale Set that the Availability Set should be migrated to. Minimum api‐version: 2024‐11‐01."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "startMigrationToVirtualMachineScaleSet",
+ "resourceType": "Microsoft.Compute/availabilitySets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/1066"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancelMigrationToVirtualMachineScaleSet",
+ "resourceType": "Microsoft.Compute/availabilitySets",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "validateMigrationToVirtualMachineScaleSet",
+ "resourceType": "Microsoft.Compute/availabilitySets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/1066"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConvertToVirtualMachineScaleSetInput",
+ "properties": {
+ "virtualMachineScaleSetName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Specifies information about the Virtual Machine Scale Set that the Availability Set should be converted to."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "convertToVirtualMachineScaleSet",
+ "resourceType": "Microsoft.Compute/availabilitySets",
+ "apiVersion": "2024-11-01",
+ "input": {
+ "$ref": "#/1070"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "restart",
+ "resourceType": "Microsoft.Compute/hostGroups/hosts",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redeploy",
+ "resourceType": "Microsoft.Compute/hostGroups/hosts",
+ "apiVersion": "2024-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SshGenerateKeyPairInputParameters",
+ "properties": {
+ "encryptionType": {
+ "type": {
+ "$ref": "#/1077"
+ },
+ "flags": 0,
+ "description": "The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RSA"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ed25519"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1075"
+ },
+ {
+ "$ref": "#/1076"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SshPublicKeyGenerateKeyPairResult",
+ "properties": {
+ "privateKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret."
+ },
+ "publicKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "generateKeyPair",
+ "resourceType": "Microsoft.Compute/sshPublicKeys",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/1078"
+ },
+ "input": {
+ "$ref": "#/1074"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RequestRateByIntervalInput",
+ "properties": {
+ "intervalLength": {
+ "type": {
+ "$ref": "#/1085"
+ },
+ "flags": 1,
+ "description": "Interval value in minutes used to create LogAnalytics call rate logs."
+ },
+ "blobContainerSasUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to."
+ },
+ "fromTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "From time of the query"
+ },
+ "toTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "To time of the query"
+ },
+ "groupByThrottlePolicy": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Throttle Policy applied."
+ },
+ "groupByOperationName": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Operation Name."
+ },
+ "groupByResourceName": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Resource Name."
+ },
+ "groupByClientApplicationId": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Client Application ID."
+ },
+ "groupByUserAgent": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by User Agent."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ThreeMins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FiveMins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ThirtyMins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SixtyMins"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1081"
+ },
+ {
+ "$ref": "#/1082"
+ },
+ {
+ "$ref": "#/1083"
+ },
+ {
+ "$ref": "#/1084"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LogAnalyticsOperationResult",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/1087"
+ },
+ "flags": 2,
+ "description": "LogAnalyticsOutput"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LogAnalyticsOutput",
+ "properties": {
+ "output": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Output file Uri path to blob container."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "getRequestRateByInterval",
+ "resourceType": "Microsoft.Compute/locations/logAnalytics",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/1086"
+ },
+ "input": {
+ "$ref": "#/1080"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThrottledRequestsInput",
+ "properties": {
+ "blobContainerSasUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to."
+ },
+ "fromTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "From time of the query"
+ },
+ "toTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "To time of the query"
+ },
+ "groupByThrottlePolicy": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Throttle Policy applied."
+ },
+ "groupByOperationName": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Operation Name."
+ },
+ "groupByResourceName": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Resource Name."
+ },
+ "groupByClientApplicationId": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by Client Application ID."
+ },
+ "groupByUserAgent": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Group query result by User Agent."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "getThrottledRequests",
+ "resourceType": "Microsoft.Compute/locations/logAnalytics",
+ "apiVersion": "2024-11-01",
+ "output": {
+ "$ref": "#/1086"
+ },
+ "input": {
+ "$ref": "#/1089"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/computeschedule/microsoft.computeschedule/2025-05-01/types.json b/internal/azure/generated/computeschedule/microsoft.computeschedule/2025-05-01/types.json
new file mode 100644
index 000000000..f76bbf824
--- /dev/null
+++ b/internal/azure/generated/computeschedule/microsoft.computeschedule/2025-05-01/types.json
@@ -0,0 +1,1401 @@
+[
+ {
+ "$type": "ObjectType",
+ "name": "CancelOperationsRequest",
+ "properties": {
+ "operationIds": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The list of operation ids to cancel operations on"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CancelOperationsResponse",
+ "properties": {
+ "results": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 1,
+ "description": "An array of resource operations that were successfully cancelled"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceOperation",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Unique identifier for the resource involved in the operation, eg ArmId"
+ },
+ "errorCode": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Resource level error code if it exists"
+ },
+ "errorDetails": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Resource level error details if they exist"
+ },
+ "operation": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Details of the operation performed on a resource"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceOperationDetails",
+ "properties": {
+ "operationId": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "Operation identifier for the unique operation"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Unique identifier for the resource involved in the operation, eg ArmId"
+ },
+ "opType": {
+ "type": {
+ "$ref": "#/10"
+ },
+ "flags": 0,
+ "description": "Type of operation performed on the resources"
+ },
+ "subscriptionId": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Subscription id attached to the request"
+ },
+ "deadline": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Deadline for the operation"
+ },
+ "deadlineType": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "Type of deadline of the operation"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 0,
+ "description": "Current state of the operation"
+ },
+ "timezone": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Timezone for the operation"
+ },
+ "timeZone": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Timezone for the operation"
+ },
+ "resourceOperationError": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "Operation level errors if they exist"
+ },
+ "completedAt": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Time the operation was complete if errors are null"
+ },
+ "retryPolicy": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "Retry policy the user can pass"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Start"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hibernate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/1"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InitiateAt"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompleteBy"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/1"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PendingScheduling"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Scheduled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PendingExecution"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Executing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cancelled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Blocked"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/15"
+ },
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/23"
+ },
+ {
+ "$ref": "#/1"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceOperationError",
+ "properties": {
+ "errorCode": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "Code for the error eg 404, 500"
+ },
+ "errorDetails": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "Detailed message about the error"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetryPolicy",
+ "properties": {
+ "retryCount": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "Retry count for user request"
+ },
+ "retryWindowInMinutes": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "Retry window in minutes for user request"
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesCancelOperations",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/3"
+ },
+ "input": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecuteCreateRequest",
+ "properties": {
+ "resourceConfigParameters": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 1,
+ "description": "resource creation payload"
+ },
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceProvisionPayload",
+ "properties": {
+ "baseProfile": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "baseProfile, Resource properties that common across all resources"
+ },
+ "resourceOverrides": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "resourceOverrides, properties per resource that needs to be overwritted from baseProfile"
+ },
+ "resourceCount": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 1,
+ "description": "Number of resources to be created"
+ },
+ "resourcePrefix": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "if resourceOverrides doesn't contain \"name\", service will create name based of prefix and ResourceCount e.g. resourceprefix-0,resourceprefix-1.."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecutionParameters",
+ "properties": {
+ "optimizationPreference": {
+ "type": {
+ "$ref": "#/37"
+ },
+ "flags": 0,
+ "description": "Details that could optimize the user's request"
+ },
+ "retryPolicy": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "Retry policy the user can pass"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Availability"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CostAvailabilityBalanced"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/1"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateResourceOperationResponse",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The description of the operation response"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The type of resources used in the create request eg virtual machines"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The location of the start request eg westus"
+ },
+ "results": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "The results from the start request if no errors exist"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesExecuteCreate",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/38"
+ },
+ "input": {
+ "$ref": "#/30"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecuteDeallocateRequest",
+ "properties": {
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Resources",
+ "properties": {
+ "ids": {
+ "type": {
+ "$ref": "#/43"
+ },
+ "flags": 1,
+ "description": "The resource ids used for the request"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DeallocateResourceOperationResponse",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The description of the operation response"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The type of resources used in the deallocate request eg virtual machines"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The location of the deallocate request eg westus"
+ },
+ "results": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 0,
+ "description": "The results from the deallocate request if no errors exist"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesExecuteDeallocate",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/44"
+ },
+ "input": {
+ "$ref": "#/41"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecuteDeleteRequest",
+ "properties": {
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "CorrelationId item"
+ },
+ "forceDeletion": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Forced delete resource item"
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DeleteResourceOperationResponse",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The description of the operation response"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The type of resources used in the delete request eg virtual machines"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The location of the start request eg westus"
+ },
+ "results": {
+ "type": {
+ "$ref": "#/50"
+ },
+ "flags": 0,
+ "description": "The results from the start request if no errors exist"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesExecuteDelete",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/49"
+ },
+ "input": {
+ "$ref": "#/47"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecuteHibernateRequest",
+ "properties": {
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "HibernateResourceOperationResponse",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The description of the operation response"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The type of resources used in the Hibernate request eg virtual machines"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The location of the Hibernate request eg westus"
+ },
+ "results": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "The results from the Hibernate request if no errors exist"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesExecuteHibernate",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/53"
+ },
+ "input": {
+ "$ref": "#/52"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecuteStartRequest",
+ "properties": {
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "StartResourceOperationResponse",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The description of the operation response"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The type of resources used in the start request eg virtual machines"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The location of the start request eg westus"
+ },
+ "results": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 0,
+ "description": "The results from the start request if no errors exist"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesExecuteStart",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/57"
+ },
+ "input": {
+ "$ref": "#/56"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetOperationErrorsRequest",
+ "properties": {
+ "operationIds": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 1,
+ "description": "The list of operation ids to query errors of"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetOperationErrorsResponse",
+ "properties": {
+ "results": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 1,
+ "description": "An array of operationids and their corresponding errors if any"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OperationErrorsResult",
+ "properties": {
+ "operationId": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The operationId identifying a vm operation"
+ },
+ "creationTime": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The creation time of the error result"
+ },
+ "activationTime": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The activation time of a vm operation"
+ },
+ "completedAt": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The completion time of the operation if the operation was completed"
+ },
+ "operationErrors": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "A list of errors associated with the operationid"
+ },
+ "requestErrorCode": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Request level error code"
+ },
+ "requestErrorDetails": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "Request level error details"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OperationErrorDetails",
+ "properties": {
+ "errorCode": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The error code of the operation"
+ },
+ "errorDetails": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "The error details of the operation"
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The timestamp of the error occurence"
+ },
+ "timeStamp": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The timestamp of the error occurence"
+ },
+ "azureOperationName": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The compute operationid of the Start/Deallocate/Hibernate request"
+ },
+ "crpOperationId": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The compute operationid of the Start/Deallocate/Hibernate request"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/64"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/63"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesGetOperationErrors",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/62"
+ },
+ "input": {
+ "$ref": "#/60"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetOperationStatusRequest",
+ "properties": {
+ "operationIds": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 1,
+ "description": "The list of operation ids to get the status of"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetOperationStatusResponse",
+ "properties": {
+ "results": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 1,
+ "description": "An array of resource operations based on their operation ids"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/4"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesGetOperationStatus",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/70"
+ },
+ "input": {
+ "$ref": "#/68"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubmitCreateRequest",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 1,
+ "description": "The schedule for the request"
+ },
+ "resourceConfigParameters": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 1,
+ "description": "resource creation payload"
+ },
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "The execution parameters for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Schedule",
+ "properties": {
+ "deadline": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The deadline for the operation"
+ },
+ "deadLine": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The deadline for the operation"
+ },
+ "timezone": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The timezone for the operation"
+ },
+ "timeZone": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "The timezone for the operation"
+ },
+ "deadlineType": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 1,
+ "description": "The deadlinetype of the operation, this can either be InitiateAt or CompleteBy"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InitiateAt"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompleteBy"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/1"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesSubmitCreate",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/38"
+ },
+ "input": {
+ "$ref": "#/73"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubmitDeallocateRequest",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 1,
+ "description": "The schedule for the request"
+ },
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesSubmitDeallocate",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/44"
+ },
+ "input": {
+ "$ref": "#/80"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubmitDeleteRequest",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 1,
+ "description": "The schedule for the request"
+ },
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 0,
+ "description": "CorrelationId item"
+ },
+ "forceDeletion": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Forced delete resource item"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesSubmitDelete",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/49"
+ },
+ "input": {
+ "$ref": "#/82"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubmitHibernateRequest",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 1,
+ "description": "The schedule for the request"
+ },
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesSubmitHibernate",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/53"
+ },
+ "input": {
+ "$ref": "#/84"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SubmitStartRequest",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 1,
+ "description": "The schedule for the request"
+ },
+ "executionParameters": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The execution parameters for the request"
+ },
+ "resources": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "The resources for the request"
+ },
+ "correlationid": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 1,
+ "description": "CorrelationId item"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "virtualMachinesSubmitStart",
+ "resourceType": "Microsoft.ComputeSchedule/locations",
+ "apiVersion": "2025-05-01",
+ "output": {
+ "$ref": "#/57"
+ },
+ "input": {
+ "$ref": "#/86"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/confidentialledger/microsoft.confidentialledger/2024-09-19-preview/types.json b/internal/azure/generated/confidentialledger/microsoft.confidentialledger/2024-09-19-preview/types.json
index 640b1c907..91c546545 100644
--- a/internal/azure/generated/confidentialledger/microsoft.confidentialledger/2024-09-19-preview/types.json
+++ b/internal/azure/generated/confidentialledger/microsoft.confidentialledger/2024-09-19-preview/types.json
@@ -1,7 +1,7 @@
[
{
"$type": "StringType",
- "pattern": "^[a-zA-Z0-9]"
+ "pattern": "^[^-0-9][A-Za-z0-9-]{1,33}[A-Za-z0-9]$"
},
{
"$type": "StringLiteralType",
@@ -667,6 +667,10 @@
},
"flags": 0
},
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9]"
+ },
{
"$type": "StringLiteralType",
"value": "Microsoft.ConfidentialLedger/managedCCFs"
@@ -688,35 +692,35 @@
},
"name": {
"type": {
- "$ref": "#/0"
+ "$ref": "#/60"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/60"
+ "$ref": "#/61"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/61"
+ "$ref": "#/62"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/63"
+ "$ref": "#/64"
},
"flags": 0,
"description": "Properties of Managed CCF Resource."
},
"tags": {
"type": {
- "$ref": "#/88"
+ "$ref": "#/89"
},
"flags": 0,
"description": "Resource tags."
@@ -764,28 +768,28 @@
},
"memberIdentityCertificates": {
"type": {
- "$ref": "#/66"
+ "$ref": "#/67"
},
"flags": 0,
"description": "List of member identity certificates for Managed CCF"
},
"deploymentType": {
"type": {
- "$ref": "#/67"
+ "$ref": "#/68"
},
"flags": 0,
"description": "Deployment Type of Managed CCF"
},
"runningState": {
"type": {
- "$ref": "#/76"
+ "$ref": "#/77"
},
"flags": 0,
"description": "Object representing RunningState for Managed CCF."
},
"provisioningState": {
"type": {
- "$ref": "#/84"
+ "$ref": "#/85"
},
"flags": 2,
"description": "Provisioning state of Managed CCF Resource"
@@ -799,7 +803,7 @@
},
"enclavePlatform": {
"type": {
- "$ref": "#/87"
+ "$ref": "#/88"
},
"flags": 0,
"description": "Enclave platform of Managed CCF."
@@ -826,7 +830,7 @@
},
"tags": {
"type": {
- "$ref": "#/65"
+ "$ref": "#/66"
},
"flags": 0,
"description": "Anything"
@@ -839,7 +843,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/64"
+ "$ref": "#/65"
}
},
{
@@ -848,7 +852,7 @@
"properties": {
"languageRuntime": {
"type": {
- "$ref": "#/70"
+ "$ref": "#/71"
},
"flags": 0,
"description": "Unique name for the Managed CCF."
@@ -874,10 +878,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/68"
+ "$ref": "#/69"
},
{
- "$ref": "#/69"
+ "$ref": "#/70"
},
{
"$ref": "#/2"
@@ -907,9 +911,6 @@
{
"$type": "UnionType",
"elements": [
- {
- "$ref": "#/71"
- },
{
"$ref": "#/72"
},
@@ -922,6 +923,9 @@
{
"$ref": "#/75"
},
+ {
+ "$ref": "#/76"
+ },
{
"$ref": "#/2"
}
@@ -958,9 +962,6 @@
{
"$type": "UnionType",
"elements": [
- {
- "$ref": "#/77"
- },
{
"$ref": "#/78"
},
@@ -979,6 +980,9 @@
{
"$ref": "#/83"
},
+ {
+ "$ref": "#/84"
+ },
{
"$ref": "#/2"
}
@@ -996,10 +1000,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/85"
+ "$ref": "#/86"
},
{
- "$ref": "#/86"
+ "$ref": "#/87"
},
{
"$ref": "#/2"
@@ -1019,7 +1023,7 @@
"name": "Microsoft.ConfidentialLedger/managedCCFs@2024-09-19-preview",
"scopeType": 8,
"body": {
- "$ref": "#/62"
+ "$ref": "#/63"
},
"flags": 0
},
@@ -1036,7 +1040,7 @@
},
"uri": {
"type": {
- "$ref": "#/91"
+ "$ref": "#/92"
},
"flags": 1,
"description": "SAS URI used to access the backup Fileshare."
@@ -1066,10 +1070,10 @@
"resourceType": "Microsoft.ConfidentialLedger/ledgers",
"apiVersion": "2024-09-19-preview",
"output": {
- "$ref": "#/92"
+ "$ref": "#/93"
},
"input": {
- "$ref": "#/90"
+ "$ref": "#/91"
}
},
{
@@ -1092,7 +1096,7 @@
},
"uri": {
"type": {
- "$ref": "#/91"
+ "$ref": "#/92"
},
"flags": 1,
"description": "SAS URI used to access the backup fileshare."
@@ -1118,10 +1122,10 @@
"resourceType": "Microsoft.ConfidentialLedger/ledgers",
"apiVersion": "2024-09-19-preview",
"output": {
- "$ref": "#/95"
+ "$ref": "#/96"
},
"input": {
- "$ref": "#/94"
+ "$ref": "#/95"
}
},
{
@@ -1137,7 +1141,7 @@
},
"uri": {
"type": {
- "$ref": "#/91"
+ "$ref": "#/92"
},
"flags": 1,
"description": "SAS URI used to access the backup Fileshare."
@@ -1163,10 +1167,10 @@
"resourceType": "Microsoft.ConfidentialLedger/managedCCFs",
"apiVersion": "2024-09-19-preview",
"output": {
- "$ref": "#/98"
+ "$ref": "#/99"
},
"input": {
- "$ref": "#/97"
+ "$ref": "#/98"
}
},
{
@@ -1189,7 +1193,7 @@
},
"uri": {
"type": {
- "$ref": "#/91"
+ "$ref": "#/92"
},
"flags": 1,
"description": "SAS URI used to access the backup Fileshare."
@@ -1215,10 +1219,10 @@
"resourceType": "Microsoft.ConfidentialLedger/managedCCFs",
"apiVersion": "2024-09-19-preview",
"output": {
- "$ref": "#/101"
+ "$ref": "#/102"
},
"input": {
- "$ref": "#/100"
+ "$ref": "#/101"
}
}
]
\ No newline at end of file
diff --git a/internal/azure/generated/containerregistry/microsoft.containerregistry/2025-03-01-preview/types.json b/internal/azure/generated/containerregistry/microsoft.containerregistry/2025-03-01-preview/types.json
new file mode 100644
index 000000000..4fcb06567
--- /dev/null
+++ b/internal/azure/generated/containerregistry/microsoft.containerregistry/2025-03-01-preview/types.json
@@ -0,0 +1,8398 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 200,
+ "pattern": "^[a-zA-Z0-9-]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/packages/archives"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/packages/archives",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The properties of the archive."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ArchiveProperties",
+ "properties": {
+ "packageSource": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "The package source of the archive."
+ },
+ "publishedVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The published version of the archive."
+ },
+ "repositoryEndpointPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "repositoryEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the archive at the time the operation was called."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ArchivePackageSourceProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The type of package source for a archive."
+ },
+ "url": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The external repository url."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "remote"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource modification (UTC)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/23"
+ },
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/packages/archives@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/packages/archives/versions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/packages/archives/versions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 2,
+ "description": "The properties of the archive."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ArchiveVersionProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/38"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the archive at the time the operation was called."
+ },
+ "archiveVersionErrorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The detailed error message for the archive version in the case of failure."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/32"
+ },
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/packages/archives/versions@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/30"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 50,
+ "pattern": "^[a-zA-Z0-9-]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/cacheRules"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/40"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/41"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 0,
+ "description": "The properties of the cache rule."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CacheRuleProperties",
+ "properties": {
+ "credentialSetResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ARM resource ID of the credential store which is associated with the cache rule."
+ },
+ "sourceRepository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Source repository pulled from upstream."
+ },
+ "targetRepository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of the cache rule."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/cacheRules@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/43"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 50,
+ "pattern": "^[a-zA-Z0-9]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/connectedRegistries"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 0,
+ "description": "The properties of the connected registry."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectedRegistryProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 1,
+ "description": "The mode of the connected registry resource that indicates the permissions of the registry."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current version of ACR runtime on the connected registry."
+ },
+ "connectionState": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 2,
+ "description": "The current connection state of the connected registry."
+ },
+ "lastActivityTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The last activity time of the connected registry."
+ },
+ "activation": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 2,
+ "description": "The activation properties of the connected registry."
+ },
+ "parent": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 1,
+ "description": "The parent of the connected registry."
+ },
+ "clientTokenIds": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry."
+ },
+ "loginServer": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 0,
+ "description": "The login server properties of the connected registry."
+ },
+ "logging": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "The logging properties of the connected registry."
+ },
+ "statusDetails": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 2,
+ "description": "The list of current statuses of the connected registry."
+ },
+ "notificationsList": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 0,
+ "description": "The list of notifications subscription information for the connected registry."
+ },
+ "garbageCollection": {
+ "type": {
+ "$ref": "#/103"
+ },
+ "flags": 0,
+ "description": "The garbage collection properties of the connected registry."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/59"
+ },
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Registry"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mirror"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Offline"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Syncing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unhealthy"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ActivationProperties",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 2,
+ "description": "The activation status of the connected registry."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Inactive"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ParentProperties",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the parent to which the connected registry will be associated."
+ },
+ "syncProperties": {
+ "type": {
+ "$ref": "#/80"
+ },
+ "flags": 1,
+ "description": "The sync properties of the connected registry with its parent."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SyncProperties",
+ "properties": {
+ "tokenId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of the ACR token used to authenticate the connected registry to its parent during sync."
+ },
+ "schedule": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The cron expression indicating the schedule that the connected registry will sync with its parent."
+ },
+ "syncWindow": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "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."
+ },
+ "messageTtl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "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."
+ },
+ "lastSyncTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The last time a sync occurred between the connected registry and its parent."
+ },
+ "gatewayEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The gateway endpoint used by the connected registry to communicate with its parent."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LoginServerProperties",
+ "properties": {
+ "host": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The host of the connected registry. Can be FQDN or IP."
+ },
+ "tls": {
+ "type": {
+ "$ref": "#/83"
+ },
+ "flags": 2,
+ "description": "The TLS properties of the connected registry login server."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TlsProperties",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 2,
+ "description": "Indicates whether HTTPS is enabled for the login server."
+ },
+ "certificate": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 2,
+ "description": "The certificate used to configure HTTPS for the login server."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TlsCertificateProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 2,
+ "description": "The type of certificate location."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Indicates the location of the certificates."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LocalDirectory"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/88"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LoggingProperties",
+ "properties": {
+ "logLevel": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 0,
+ "description": "The verbosity of logs persisted on the connected registry."
+ },
+ "auditLogStatus": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "Indicates whether audit logs are enabled on the connected registry."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Debug"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Information"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/91"
+ },
+ {
+ "$ref": "#/92"
+ },
+ {
+ "$ref": "#/93"
+ },
+ {
+ "$ref": "#/94"
+ },
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/97"
+ },
+ {
+ "$ref": "#/98"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "StatusDetailProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The component of the connected registry corresponding to the status."
+ },
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The code of the status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The description of the status."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp of the status."
+ },
+ "correlationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The correlation ID of the status."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/100"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GarbageCollectionProperties",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "Indicates whether garbage collection is enabled for the connected registry."
+ },
+ "schedule": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The cron expression indicating the schedule that the connected registry will run garbage collection."
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/connectedRegistries@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/56"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/credentialSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/40"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "Identities associated with the resource. This is used to access the KeyVault secrets."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "The properties of the credential set."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IdentityProperties",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal ID of resource identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant ID of resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "The identity type."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned, UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserIdentityProperties",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IdentityPropertiesUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/115"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialSetProperties",
+ "properties": {
+ "loginServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The credentials are stored for this upstream or login server."
+ },
+ "authCredentials": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of credential store resource."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AuthCredential",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 0,
+ "description": "The name of the credential."
+ },
+ "usernameSecretIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "KeyVault Secret URI for accessing the username."
+ },
+ "passwordSecretIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "KeyVault Secret URI for accessing the password."
+ },
+ "credentialHealth": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 2,
+ "description": "This provides data pertaining to the health of the auth credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Credential1"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialHealth",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "The health status of credential."
+ },
+ "errorCode": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error code representing the health check error."
+ },
+ "errorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Descriptive message representing the health check error."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Healthy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unhealthy"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/118"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/128"
+ },
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/credentialSets@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/108"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/exportPipelines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/exportPipelines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the export pipeline."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "The identity of the export pipeline."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/137"
+ },
+ "flags": 0,
+ "description": "The properties of the export pipeline."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportPipelineProperties",
+ "properties": {
+ "target": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 1,
+ "description": "The target properties of the export pipeline."
+ },
+ "options": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "The list of all options configured for the pipeline."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the pipeline at the time the operation was called."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportPipelineTargetProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The type of target for the export pipeline."
+ },
+ "uri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target uri of the export pipeline.\r\nWhen 'AzureStorageBlob': \"https://accountName.blob.core.windows.net/containerName/blobName\"\r\nWhen 'AzureStorageBlobContainer': \"https://accountName.blob.core.windows.net/containerName\""
+ },
+ "keyVaultUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "They key vault secret uri to obtain the target storage SAS token."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwriteTags"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwriteBlobs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DeleteSourceBlobOnSuccess"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ContinueOnErrors"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/139"
+ },
+ {
+ "$ref": "#/140"
+ },
+ {
+ "$ref": "#/141"
+ },
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/143"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/147"
+ },
+ {
+ "$ref": "#/148"
+ },
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/exportPipelines@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/136"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 1,
+ "description": "The SKU of the container registry."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "The identity of the container registry."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/167"
+ },
+ "flags": 0,
+ "description": "The properties of the container registry."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Sku",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/161"
+ },
+ "flags": 1,
+ "description": "The SKU name of the container registry. Required for registry creation."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 2,
+ "description": "The SKU tier based on the SKU name."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Classic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/159"
+ },
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Classic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/162"
+ },
+ {
+ "$ref": "#/163"
+ },
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/165"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegistryProperties",
+ "properties": {
+ "loginServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The URL that can be used to log into the container registry."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of the container registry in ISO8601 format."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the container registry at the time the operation was called."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 2,
+ "description": "The status of the container registry at the time the operation was called."
+ },
+ "adminUserEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the admin user is enabled."
+ },
+ "networkRuleSet": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "The network rule set for a container registry."
+ },
+ "policies": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "The policies for a container registry."
+ },
+ "encryption": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "The encryption settings of container registry."
+ },
+ "dataEndpointEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "Enable a single data endpoint per region for serving data."
+ },
+ "dataEndpointHostNames": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 2,
+ "description": "List of host names that will serve data when dataEndpointEnabled is true."
+ },
+ "privateEndpointConnections": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 2,
+ "description": "List of private endpoint connections for a container registry."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/240"
+ },
+ "flags": 0,
+ "description": "Whether or not public network access is allowed for the container registry."
+ },
+ "networkRuleBypassOptions": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 0,
+ "description": "Whether to allow trusted Azure services to access a network restricted registry."
+ },
+ "zoneRedundancy": {
+ "type": {
+ "$ref": "#/246"
+ },
+ "flags": 0,
+ "description": "Whether or not zone redundancy is enabled for this container registry"
+ },
+ "anonymousPullEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "Enables registry-wide pull from unauthenticated clients."
+ },
+ "metadataSearch": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Determines whether registry artifacts are indexed for metadata search."
+ },
+ "autoGeneratedDomainNameLabelScope": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 0,
+ "description": "Determines the domain name label reuse scope."
+ },
+ "roleAssignmentMode": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 0,
+ "description": "Determines registry role assignment mode."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/169"
+ },
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Status",
+ "properties": {
+ "displayStatus": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The short label for the status."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The detailed message for the status, including alerts and error messages."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp when the status was changed to the current value."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkRuleSet",
+ "properties": {
+ "defaultAction": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 1,
+ "description": "The default action of allow or deny when no other rules match."
+ },
+ "ipRules": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 0,
+ "description": "The IP ACL rules."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Allow"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deny"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IPRule",
+ "properties": {
+ "action": {
+ "type": {
+ "$ref": "#/182"
+ },
+ "flags": 0,
+ "description": "The action of IP ACL rule."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Allow"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/181"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/180"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Policies",
+ "properties": {
+ "quarantinePolicy": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 0,
+ "description": "The quarantine policy for a container registry."
+ },
+ "trustPolicy": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 0,
+ "description": "The content trust policy for a container registry."
+ },
+ "retentionPolicy": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "The retention policy for a container registry."
+ },
+ "exportPolicy": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "The export policy for a container registry."
+ },
+ "azureADAuthenticationAsArmPolicy": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "The policy for using ARM audience token for a container registry."
+ },
+ "softDeletePolicy": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "The soft delete policy for a container registry."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QuarantinePolicy",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/186"
+ },
+ {
+ "$ref": "#/187"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrustPolicy",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "The type of trust policy."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Notary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/190"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetentionPolicy",
+ "properties": {
+ "days": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The number of days to retain an untagged manifest after which it gets purged."
+ },
+ "lastUpdatedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp when the policy was last updated."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/197"
+ },
+ {
+ "$ref": "#/198"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportPolicy",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/203"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/201"
+ },
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureADAuthenticationAsArmPolicy",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/206"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SoftDeletePolicy",
+ "properties": {
+ "retentionDays": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The number of days after which a soft-deleted item is permanently deleted."
+ },
+ "lastUpdatedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp when the policy was last updated."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionProperty",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "Indicates whether or not the encryption is enabled for container registry."
+ },
+ "keyVaultProperties": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 0,
+ "description": "Key vault properties."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/213"
+ },
+ {
+ "$ref": "#/214"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyVaultProperties",
+ "properties": {
+ "keyIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Key vault uri to access the encryption key."
+ },
+ "versionedKeyIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The fully qualified key identifier that includes the version of the key that is actually used for encryption."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client id of the identity which will be used to access key vault."
+ },
+ "keyRotationEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 2,
+ "description": "Auto key rotation status for a CMK enabled registry."
+ },
+ "lastKeyRotationTimestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Timestamp of the last successful key rotation."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnection",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource ID."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 0,
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 2,
+ "description": "The provisioning state of private endpoint connection resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is private endpoint resource created with Microsoft.Network resource provider."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The description for connection status. For example if connection is rejected it can indicate reason for rejection."
+ },
+ "actionsRequired": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "A message indicating if changes on the service provider require any updates on the consumer."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/222"
+ },
+ {
+ "$ref": "#/223"
+ },
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Recreate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/227"
+ },
+ {
+ "$ref": "#/228"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/230"
+ },
+ {
+ "$ref": "#/231"
+ },
+ {
+ "$ref": "#/232"
+ },
+ {
+ "$ref": "#/233"
+ },
+ {
+ "$ref": "#/234"
+ },
+ {
+ "$ref": "#/235"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/218"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/238"
+ },
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureServices"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/241"
+ },
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/244"
+ },
+ {
+ "$ref": "#/245"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/248"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unsecure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TenantReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SubscriptionReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ResourceGroupReuse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoReuse"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/250"
+ },
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/252"
+ },
+ {
+ "$ref": "#/253"
+ },
+ {
+ "$ref": "#/254"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AbacRepositoryPermissions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LegacyRegistryPermissions"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/257"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/155"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/importPipelines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/importPipelines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the import pipeline."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "The identity of the import pipeline."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 0,
+ "description": "The properties of the import pipeline."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportPipelineProperties",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/265"
+ },
+ "flags": 1,
+ "description": "The source properties of the import pipeline."
+ },
+ "trigger": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 0,
+ "description": "The properties that describe the trigger of the import pipeline."
+ },
+ "options": {
+ "type": {
+ "$ref": "#/278"
+ },
+ "flags": 0,
+ "description": "The list of all options configured for the pipeline."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the pipeline at the time the operation was called."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportPipelineSourceProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 0,
+ "description": "The type of source for the import pipeline."
+ },
+ "uri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source uri of the import pipeline.\r\nWhen 'AzureStorageBlob': \"https://accountName.blob.core.windows.net/containerName/blobName\"\r\nWhen 'AzureStorageBlobContainer': \"https://accountName.blob.core.windows.net/containerName\""
+ },
+ "keyVaultUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "They key vault secret uri to obtain the source storage SAS token."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureStorageBlobContainer"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineTriggerProperties",
+ "properties": {
+ "sourceTrigger": {
+ "type": {
+ "$ref": "#/269"
+ },
+ "flags": 0,
+ "description": "The source trigger properties of the pipeline."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineSourceTriggerProperties",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/272"
+ },
+ "flags": 1,
+ "description": "The current status of the source trigger."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwriteTags"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwriteBlobs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DeleteSourceBlobOnSuccess"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ContinueOnErrors"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/273"
+ },
+ {
+ "$ref": "#/274"
+ },
+ {
+ "$ref": "#/275"
+ },
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/277"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/281"
+ },
+ {
+ "$ref": "#/282"
+ },
+ {
+ "$ref": "#/283"
+ },
+ {
+ "$ref": "#/284"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/importPipelines@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/263"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/pipelineRuns"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 0,
+ "description": "The properties of a pipeline run."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineRunProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 2,
+ "description": "The provisioning state of a pipeline run."
+ },
+ "request": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 0,
+ "description": "The request parameters for a pipeline run."
+ },
+ "response": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 2,
+ "description": "The response of a pipeline run."
+ },
+ "forceUpdateTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/291"
+ },
+ {
+ "$ref": "#/292"
+ },
+ {
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/296"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineRunRequest",
+ "properties": {
+ "pipelineResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the pipeline to run."
+ },
+ "artifacts": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 0,
+ "description": "List of source artifacts to be transferred by the pipeline. \r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123')."
+ },
+ "source": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 0,
+ "description": "The source properties of the pipeline run."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 0,
+ "description": "The target properties of the pipeline run."
+ },
+ "catalogDigest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The digest of the tar used to transfer the artifacts."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineRunSourceProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 0,
+ "description": "The type of the source."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the source."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureStorageBlob"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/301"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineRunTargetProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 0,
+ "description": "The type of the target."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the target."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureStorageBlob"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/304"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineRunResponse",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The current status of the pipeline run."
+ },
+ "importedArtifacts": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "The artifacts imported in the pipeline run."
+ },
+ "progress": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 0,
+ "description": "The current progress of the copy operation."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time the pipeline run started."
+ },
+ "finishTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time the pipeline run finished."
+ },
+ "source": {
+ "type": {
+ "$ref": "#/265"
+ },
+ "flags": 0,
+ "description": "The source of the pipeline run."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "The target of the pipeline run."
+ },
+ "catalogDigest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The digest of the tar used to transfer the artifacts."
+ },
+ "trigger": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The trigger that caused the pipeline run."
+ },
+ "pipelineRunErrorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The detailed error message for the pipeline run in the case of failure."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProgressProperties",
+ "properties": {
+ "percentage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The percentage complete of the copy operation."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineTriggerDescriptor",
+ "properties": {
+ "sourceTrigger": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "The source trigger that caused the pipeline run."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PipelineSourceTriggerDescriptor",
+ "properties": {
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp when the source update happened."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/pipelineRuns@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/289"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/privateEndpointConnections@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/314"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/replications"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/replications",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "The properties of the replication."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReplicationProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the replication at the time the operation was called."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 2,
+ "description": "The status of the replication at the time the operation was called."
+ },
+ "regionEndpointEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "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."
+ },
+ "zoneRedundancy": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 0,
+ "description": "Whether or not zone redundancy is enabled for this container registry replication"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/320"
+ },
+ {
+ "$ref": "#/321"
+ },
+ {
+ "$ref": "#/322"
+ },
+ {
+ "$ref": "#/323"
+ },
+ {
+ "$ref": "#/324"
+ },
+ {
+ "$ref": "#/325"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/327"
+ },
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/replications@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/318"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 50,
+ "pattern": "^[a-zA-Z0-9-_]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/scopeMaps"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/334"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/336"
+ },
+ "flags": 0,
+ "description": "The properties of the scope map."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScopeMapProperties",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The user friendly description of the scope map."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the scope map. E.g. BuildIn scope map."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of scope map."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/343"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ },
+ "actions": {
+ "type": {
+ "$ref": "#/344"
+ },
+ "flags": 1,
+ "description": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/337"
+ },
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/scopeMaps@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/335"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/tokens"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/40"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/346"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/349"
+ },
+ "flags": 0,
+ "description": "The properties of the token."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenProperties",
+ "properties": {
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of scope map."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ },
+ "scopeMapId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the scope map to which the token will be associated with."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/357"
+ },
+ "flags": 0,
+ "description": "The credentials that can be used for authenticating the token."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 0,
+ "description": "The status of the token example enabled or disabled."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/350"
+ },
+ {
+ "$ref": "#/351"
+ },
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/353"
+ },
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/355"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenCredentialsProperties",
+ "properties": {
+ "certificates": {
+ "type": {
+ "$ref": "#/362"
+ },
+ "flags": 0
+ },
+ "passwords": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenCertificate",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0
+ },
+ "expiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The expiry datetime of the certificate."
+ },
+ "thumbprint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The thumbprint of the certificate."
+ },
+ "encodedPemCertificate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "certificate1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "certificate2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/359"
+ },
+ {
+ "$ref": "#/360"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/358"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenPassword",
+ "properties": {
+ "creationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The creation datetime of the password."
+ },
+ "expiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The expiry datetime of the password."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/366"
+ },
+ "flags": 0,
+ "description": "The password name \"password1\" or \"password2\""
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The password value."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/364"
+ },
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/363"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/tokens@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/348"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/webhooks"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/webhooks",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/372"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/375"
+ },
+ "flags": 0,
+ "description": "The tags for the webhook."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the webhook. This cannot be changed after the resource is created."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 0,
+ "description": "The properties that the webhook will be created with."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WebhookCreateParametersTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WebhookPropertiesCreateParametersOrWebhookProperties",
+ "properties": {
+ "serviceUri": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 5,
+ "description": "The service URI for the webhook to post notifications."
+ },
+ "customHeaders": {
+ "type": {
+ "$ref": "#/378"
+ },
+ "flags": 4,
+ "description": "Custom headers that will be added to the webhook notifications."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/381"
+ },
+ "flags": 0,
+ "description": "The status of the webhook at the time the operation was called."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "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."
+ },
+ "actions": {
+ "type": {
+ "$ref": "#/388"
+ },
+ "flags": 1,
+ "description": "The list of actions that trigger the webhook to post notifications."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the webhook at the time the operation was called."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WebhookPropertiesCreateParametersCustomHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "push"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "quarantine"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "chart_push"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "chart_delete"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/382"
+ },
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/384"
+ },
+ {
+ "$ref": "#/385"
+ },
+ {
+ "$ref": "#/386"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/387"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/389"
+ },
+ {
+ "$ref": "#/390"
+ },
+ {
+ "$ref": "#/391"
+ },
+ {
+ "$ref": "#/392"
+ },
+ {
+ "$ref": "#/393"
+ },
+ {
+ "$ref": "#/394"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/webhooks@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/374"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 20,
+ "pattern": "^[a-zA-Z0-9-]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/agentPools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/agentPools",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/397"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/398"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/399"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "The properties associated with the agent pool"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolProperties",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The count of agent machine"
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Tier of agent machine"
+ },
+ "os": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 0,
+ "description": "The OS of agent machine"
+ },
+ "virtualNetworkSubnetResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Virtual Network Subnet Resource Id of the agent machine"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 2,
+ "description": "The provisioning state of this agent pool"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/402"
+ },
+ {
+ "$ref": "#/403"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/405"
+ },
+ {
+ "$ref": "#/406"
+ },
+ {
+ "$ref": "#/407"
+ },
+ {
+ "$ref": "#/408"
+ },
+ {
+ "$ref": "#/409"
+ },
+ {
+ "$ref": "#/410"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/agentPools@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/400"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/taskRuns"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/taskRuns",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/40"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/414"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/415"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 0,
+ "description": "The properties associated with the task run, i.e., request and result of the run"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TaskRunProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/424"
+ },
+ "flags": 2,
+ "description": "The provisioning state of this task run"
+ },
+ "runRequest": {
+ "type": {
+ "$ref": "#/425"
+ },
+ "flags": 0,
+ "description": "The request (parameters) for the run"
+ },
+ "runResult": {
+ "type": {
+ "$ref": "#/470"
+ },
+ "flags": 2,
+ "description": "The result of this task run"
+ },
+ "forceUpdateTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "How the run should be forced to rerun even if the run request configuration has not changed"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/418"
+ },
+ {
+ "$ref": "#/419"
+ },
+ {
+ "$ref": "#/420"
+ },
+ {
+ "$ref": "#/421"
+ },
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "RunRequest",
+ "discriminator": "type",
+ "baseProperties": {
+ "isArchiveEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether archiving is enabled for the run or not."
+ },
+ "agentPoolName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The dedicated agent pool for the run."
+ },
+ "logTemplate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The template that describes the repository and tag information for run log artifact."
+ }
+ },
+ "elements": {
+ "DockerBuildRequest": {
+ "$ref": "#/426"
+ },
+ "EncodedTaskRunRequest": {
+ "$ref": "#/458"
+ },
+ "FileTaskRunRequest": {
+ "$ref": "#/462"
+ },
+ "TaskRunRequest": {
+ "$ref": "#/465"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DockerBuildRequest",
+ "properties": {
+ "imageNames": {
+ "type": {
+ "$ref": "#/427"
+ },
+ "flags": 0,
+ "description": "The fully qualified image names including the repository and tag."
+ },
+ "isPushEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value of this property indicates whether the image built should be pushed to the registry or not."
+ },
+ "noCache": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value of this property indicates whether the image cache is enabled or not."
+ },
+ "dockerFilePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The Docker file path relative to the source location."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the target build stage for the docker build."
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/429"
+ },
+ "flags": 0,
+ "description": "The collection of override arguments to be used when executing the run."
+ },
+ "timeout": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 0,
+ "description": "Run timeout in seconds."
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 1,
+ "description": "The platform properties against which the run has to happen."
+ },
+ "agentConfiguration": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 0,
+ "description": "The machine configuration of the run agent."
+ },
+ "sourceLocation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 0,
+ "description": "The properties that describes a set of credentials that will be used when this run is invoked."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 1,
+ "description": "The type of the run request."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Argument",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the argument."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The value of the argument."
+ },
+ "isSecret": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether the argument represents a secret and want to be removed from build logs."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/428"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 300,
+ "maxValue": 28800
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PlatformProperties",
+ "properties": {
+ "os": {
+ "type": {
+ "$ref": "#/434"
+ },
+ "flags": 1,
+ "description": "The operating system type required for the run."
+ },
+ "architecture": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 0,
+ "description": "The OS architecture."
+ },
+ "variant": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 0,
+ "description": "Variant of the CPU."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "amd64"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "x86"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "386"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "arm"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "arm64"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/435"
+ },
+ {
+ "$ref": "#/436"
+ },
+ {
+ "$ref": "#/437"
+ },
+ {
+ "$ref": "#/438"
+ },
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "v6"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "v7"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "v8"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/441"
+ },
+ {
+ "$ref": "#/442"
+ },
+ {
+ "$ref": "#/443"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentProperties",
+ "properties": {
+ "cpu": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The CPU configuration in terms of number of cores required for the run."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Credentials",
+ "properties": {
+ "sourceRegistry": {
+ "type": {
+ "$ref": "#/447"
+ },
+ "flags": 0,
+ "description": "Describes the credential parameters for accessing the source registry."
+ },
+ "customRegistries": {
+ "type": {
+ "$ref": "#/456"
+ },
+ "flags": 0,
+ "description": "Describes the credential parameters for accessing other custom registries. The key\r\nfor the dictionary item will be the registry login server (myregistry.azurecr.io) and\r\nthe value of the item will be the registry credentials for accessing the registry."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceRegistryCredentials",
+ "properties": {
+ "identity": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Entra identity used for source registry login.\r\nThe value is `[system]` for system-assigned managed identity, `[caller]` for caller identity,\r\nand client ID for user-assigned managed identity."
+ },
+ "loginMode": {
+ "type": {
+ "$ref": "#/450"
+ },
+ "flags": 0,
+ "description": "The authentication mode which determines the source registry login scope. The credentials for the source registry\r\nwill be generated using the given scope. These credentials will be used to login to\r\nthe source registry during the run."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/448"
+ },
+ {
+ "$ref": "#/449"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CustomRegistryCredentials",
+ "properties": {
+ "userName": {
+ "type": {
+ "$ref": "#/452"
+ },
+ "flags": 0,
+ "description": "The username for logging into the custom registry."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/452"
+ },
+ "flags": 0,
+ "description": "The password for logging into the custom registry. The password is a secret \r\nobject that allows multiple ways of providing the value for it."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Indicates the managed identity assigned to the custom credential. If a user-assigned identity\r\nthis value is the Client ID. If a system-assigned identity, the value will be `system`. In\r\nthe case of a system-assigned identity, the Client ID will be determined by the runner. This\r\nidentity may be used to authenticate to key vault to retrieve credentials or it may be the only \r\nsource of authentication used for accessing the registry."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecretObject",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The value of the secret. The format of this value will be determined\r\nbased on the type of the secret object. If the type is Opaque, the value will be\r\nused as is without any modification."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 0,
+ "description": "The type of the secret object which determines how the value of the secret object has to be\r\ninterpreted."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Opaque"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Vaultsecret"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/453"
+ },
+ {
+ "$ref": "#/454"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialsCustomRegistries",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/451"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DockerBuildRequest"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncodedTaskRunRequest",
+ "properties": {
+ "encodedTaskContent": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Base64 encoded value of the template/definition file content."
+ },
+ "encodedValuesContent": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Base64 encoded value of the parameters/values file content."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/460"
+ },
+ "flags": 0,
+ "description": "The collection of overridable values that can be passed when running a task."
+ },
+ "timeout": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 0,
+ "description": "Run timeout in seconds."
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 1,
+ "description": "The platform properties against which the run has to happen."
+ },
+ "agentConfiguration": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 0,
+ "description": "The machine configuration of the run agent."
+ },
+ "sourceLocation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 0,
+ "description": "The properties that describes a set of credentials that will be used when this run is invoked."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 1,
+ "description": "The type of the run request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SetValue",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the overridable value."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The overridable value."
+ },
+ "isSecret": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether the value represents a secret or not."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/459"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EncodedTaskRunRequest"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileTaskRunRequest",
+ "properties": {
+ "taskFilePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The template/definition file path relative to the source."
+ },
+ "valuesFilePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The values/parameters file path relative to the source."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 0,
+ "description": "The collection of overridable values that can be passed when running a task."
+ },
+ "timeout": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 0,
+ "description": "Run timeout in seconds."
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 1,
+ "description": "The platform properties against which the run has to happen."
+ },
+ "agentConfiguration": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 0,
+ "description": "The machine configuration of the run agent."
+ },
+ "sourceLocation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 0,
+ "description": "The properties that describes a set of credentials that will be used when this run is invoked."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/464"
+ },
+ "flags": 1,
+ "description": "The type of the run request."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/459"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FileTaskRunRequest"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TaskRunRequest",
+ "properties": {
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of task against which run has to be queued."
+ },
+ "overrideTaskStepProperties": {
+ "type": {
+ "$ref": "#/466"
+ },
+ "flags": 0,
+ "description": "Set of overridable parameters that can be passed when running a Task."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/469"
+ },
+ "flags": 1,
+ "description": "The type of the run request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OverrideTaskStepProperties",
+ "properties": {
+ "contextPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source context against which run has to be queued."
+ },
+ "file": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The file against which run has to be queued."
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/467"
+ },
+ "flags": 0,
+ "description": "Gets or sets the collection of override arguments to be used when\r\nexecuting a build step."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the target build stage for the docker build."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/468"
+ },
+ "flags": 0,
+ "description": "The collection of overridable values that can be passed when running a Task."
+ },
+ "updateTriggerToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Base64 encoded update trigger token that will be attached with the base image trigger webhook."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/428"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/459"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TaskRunRequest"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Run",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/471"
+ },
+ "flags": 0,
+ "description": "The properties of a run."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource ID."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunProperties",
+ "properties": {
+ "runId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the run."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/480"
+ },
+ "flags": 0,
+ "description": "The current status of the run."
+ },
+ "lastUpdatedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The last updated time for the run."
+ },
+ "runType": {
+ "type": {
+ "$ref": "#/485"
+ },
+ "flags": 0,
+ "description": "The type of run."
+ },
+ "agentPoolName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The dedicated agent pool for the run."
+ },
+ "createTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time the run was scheduled."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time the run started."
+ },
+ "finishTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time the run finished."
+ },
+ "outputImages": {
+ "type": {
+ "$ref": "#/487"
+ },
+ "flags": 0,
+ "description": "The list of all images that were generated from the run. This is applicable if the run generates base image dependencies."
+ },
+ "task": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The task against which run was scheduled."
+ },
+ "imageUpdateTrigger": {
+ "type": {
+ "$ref": "#/488"
+ },
+ "flags": 0,
+ "description": "The image update trigger that caused the run. This is applicable if the task has base image trigger configured."
+ },
+ "sourceTrigger": {
+ "type": {
+ "$ref": "#/490"
+ },
+ "flags": 0,
+ "description": "The source trigger that caused the run."
+ },
+ "timerTrigger": {
+ "type": {
+ "$ref": "#/491"
+ },
+ "flags": 0,
+ "description": "The timer trigger that caused the run."
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 0,
+ "description": "The platform properties against which the run will happen."
+ },
+ "agentConfiguration": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 0,
+ "description": "The machine configuration of the run agent."
+ },
+ "sourceRegistryAuth": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The scope of the credentials that were used to login to the source registry during this run."
+ },
+ "customRegistries": {
+ "type": {
+ "$ref": "#/492"
+ },
+ "flags": 0,
+ "description": "The list of custom registries that were logged in during this run."
+ },
+ "runErrorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The error message received from backend systems after the run is scheduled."
+ },
+ "updateTriggerToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The update trigger token passed for the Run."
+ },
+ "logArtifact": {
+ "type": {
+ "$ref": "#/486"
+ },
+ "flags": 2,
+ "description": "The image description for the log artifact."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/499"
+ },
+ "flags": 0,
+ "description": "The provisioning state of a run."
+ },
+ "isArchiveEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether archiving is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Queued"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Started"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Timeout"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/472"
+ },
+ {
+ "$ref": "#/473"
+ },
+ {
+ "$ref": "#/474"
+ },
+ {
+ "$ref": "#/475"
+ },
+ {
+ "$ref": "#/476"
+ },
+ {
+ "$ref": "#/477"
+ },
+ {
+ "$ref": "#/478"
+ },
+ {
+ "$ref": "#/479"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "QuickBuild"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "QuickRun"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutoBuild"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AutoRun"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/481"
+ },
+ {
+ "$ref": "#/482"
+ },
+ {
+ "$ref": "#/483"
+ },
+ {
+ "$ref": "#/484"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageDescriptor",
+ "properties": {
+ "registry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The registry login server."
+ },
+ "repository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The repository name."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The tag name."
+ },
+ "digest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The sha256-based digest of the image manifest."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/486"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageUpdateTrigger",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique ID of the trigger."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp when the image update happened."
+ },
+ "images": {
+ "type": {
+ "$ref": "#/489"
+ },
+ "flags": 0,
+ "description": "The list of image updates that caused the build."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/486"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceTriggerDescriptor",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique ID of the trigger."
+ },
+ "eventType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event type of the trigger."
+ },
+ "commitId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique ID that identifies a commit."
+ },
+ "pullRequestId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique ID that identifies pull request."
+ },
+ "repositoryUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The repository URL."
+ },
+ "branchName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The branch name in the repository."
+ },
+ "providerType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source control provider type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimerTriggerDescriptor",
+ "properties": {
+ "timerTriggerName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timer trigger name that caused the run."
+ },
+ "scheduleOccurrence": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The occurrence that triggered the run."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/493"
+ },
+ {
+ "$ref": "#/494"
+ },
+ {
+ "$ref": "#/495"
+ },
+ {
+ "$ref": "#/496"
+ },
+ {
+ "$ref": "#/497"
+ },
+ {
+ "$ref": "#/498"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/taskRuns@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/416"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/tasks"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/tasks",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/501"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/502"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/504"
+ },
+ "flags": 0,
+ "description": "The properties of a task."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/564"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TaskProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/511"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the task."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of task."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/514"
+ },
+ "flags": 0,
+ "description": "The current status of task."
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 0,
+ "description": "The platform properties against which the run has to happen."
+ },
+ "agentConfiguration": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 0,
+ "description": "The machine configuration of the run agent."
+ },
+ "agentPoolName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The dedicated agent pool for the task."
+ },
+ "timeout": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 0,
+ "description": "Run timeout in seconds."
+ },
+ "step": {
+ "type": {
+ "$ref": "#/515"
+ },
+ "flags": 0,
+ "description": "The properties of a task step."
+ },
+ "trigger": {
+ "type": {
+ "$ref": "#/531"
+ },
+ "flags": 0,
+ "description": "The properties that describe all triggers for the task."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 0,
+ "description": "The properties that describes a set of credentials that will be used when this run is invoked."
+ },
+ "logTemplate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The template that describes the repository and tag information for run log artifact."
+ },
+ "isSystemTask": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value of this property indicates whether the task resource is system task or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/505"
+ },
+ {
+ "$ref": "#/506"
+ },
+ {
+ "$ref": "#/507"
+ },
+ {
+ "$ref": "#/508"
+ },
+ {
+ "$ref": "#/509"
+ },
+ {
+ "$ref": "#/510"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/512"
+ },
+ {
+ "$ref": "#/513"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "TaskStepProperties",
+ "discriminator": "type",
+ "baseProperties": {
+ "baseImageDependencies": {
+ "type": {
+ "$ref": "#/520"
+ },
+ "flags": 2,
+ "description": "List of base image dependencies for a step."
+ },
+ "contextPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL(absolute or relative) of the source context for the task step."
+ },
+ "contextAccessToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The token (git PAT or SAS token of storage account blob) associated with the context for a step."
+ }
+ },
+ "elements": {
+ "Docker": {
+ "$ref": "#/521"
+ },
+ "EncodedTask": {
+ "$ref": "#/525"
+ },
+ "FileTask": {
+ "$ref": "#/528"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BaseImageDependency",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/519"
+ },
+ "flags": 0,
+ "description": "The type of the base image dependency."
+ },
+ "registry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The registry login server."
+ },
+ "repository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The repository name."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The tag name."
+ },
+ "digest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The sha256-based digest of the image manifest."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuildTime"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RunTime"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/517"
+ },
+ {
+ "$ref": "#/518"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/516"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DockerBuildStep",
+ "properties": {
+ "imageNames": {
+ "type": {
+ "$ref": "#/522"
+ },
+ "flags": 0,
+ "description": "The fully qualified image names including the repository and tag."
+ },
+ "isPushEnabled": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value of this property indicates whether the image built should be pushed to the registry or not."
+ },
+ "noCache": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The value of this property indicates whether the image cache is enabled or not."
+ },
+ "dockerFilePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The Docker file path relative to the source context."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the target build stage for the docker build."
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/523"
+ },
+ "flags": 0,
+ "description": "The collection of override arguments to be used when executing this build step."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/524"
+ },
+ "flags": 1,
+ "description": "The type of the step."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/428"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Docker"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncodedTaskStep",
+ "properties": {
+ "encodedTaskContent": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Base64 encoded value of the template/definition file content."
+ },
+ "encodedValuesContent": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Base64 encoded value of the parameters/values file content."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/526"
+ },
+ "flags": 0,
+ "description": "The collection of overridable values that can be passed when running a task."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/527"
+ },
+ "flags": 1,
+ "description": "The type of the step."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/459"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EncodedTask"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileTaskStep",
+ "properties": {
+ "taskFilePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The task template/definition file path relative to the source context."
+ },
+ "valuesFilePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The task values/parameters file path relative to the source context."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/529"
+ },
+ "flags": 0,
+ "description": "The collection of overridable values that can be passed when running a task."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/530"
+ },
+ "flags": 1,
+ "description": "The type of the step."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/459"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FileTask"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TriggerProperties",
+ "properties": {
+ "timerTriggers": {
+ "type": {
+ "$ref": "#/536"
+ },
+ "flags": 0,
+ "description": "The collection of timer triggers."
+ },
+ "sourceTriggers": {
+ "type": {
+ "$ref": "#/553"
+ },
+ "flags": 0,
+ "description": "The collection of triggers based on source code repository."
+ },
+ "baseImageTrigger": {
+ "type": {
+ "$ref": "#/554"
+ },
+ "flags": 0,
+ "description": "The trigger based on base image dependencies."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimerTrigger",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The CRON expression for the task schedule"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/535"
+ },
+ "flags": 0,
+ "description": "The current status of trigger."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the trigger."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/533"
+ },
+ {
+ "$ref": "#/534"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/532"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceTrigger",
+ "properties": {
+ "sourceRepository": {
+ "type": {
+ "$ref": "#/538"
+ },
+ "flags": 1,
+ "description": "The properties that describes the source(code) for the task."
+ },
+ "sourceTriggerEvents": {
+ "type": {
+ "$ref": "#/549"
+ },
+ "flags": 1,
+ "description": "The source event corresponding to the trigger."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/552"
+ },
+ "flags": 0,
+ "description": "The current status of trigger."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the trigger."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceProperties",
+ "properties": {
+ "sourceControlType": {
+ "type": {
+ "$ref": "#/541"
+ },
+ "flags": 1,
+ "description": "The type of source control service."
+ },
+ "repositoryUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The full URL to the source code repository"
+ },
+ "branch": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The branch name of the source code."
+ },
+ "sourceControlAuthProperties": {
+ "type": {
+ "$ref": "#/542"
+ },
+ "flags": 0,
+ "description": "The authorization properties for accessing the source code repository and to set up\r\nwebhooks for notifications."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Github"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VisualStudioTeamService"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/539"
+ },
+ {
+ "$ref": "#/540"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AuthInfo",
+ "properties": {
+ "tokenType": {
+ "type": {
+ "$ref": "#/545"
+ },
+ "flags": 1,
+ "description": "The type of Auth token."
+ },
+ "token": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The access token used to access the source control provider."
+ },
+ "refreshToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The refresh token used to refresh the access token."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The scope of the access token."
+ },
+ "expiresIn": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "Time in seconds that the token remains valid"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PAT"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OAuth"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/543"
+ },
+ {
+ "$ref": "#/544"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "commit"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pullrequest"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/546"
+ },
+ {
+ "$ref": "#/547"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/548"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/550"
+ },
+ {
+ "$ref": "#/551"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/537"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BaseImageTrigger",
+ "properties": {
+ "baseImageTriggerType": {
+ "type": {
+ "$ref": "#/557"
+ },
+ "flags": 1,
+ "description": "The type of the auto trigger for base image dependency updates."
+ },
+ "updateTriggerEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The endpoint URL for receiving update triggers."
+ },
+ "updateTriggerPayloadType": {
+ "type": {
+ "$ref": "#/560"
+ },
+ "flags": 0,
+ "description": "Type of Payload body for Base image update triggers."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/563"
+ },
+ "flags": 0,
+ "description": "The current status of trigger."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the trigger."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "All"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Runtime"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/555"
+ },
+ {
+ "$ref": "#/556"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Token"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/558"
+ },
+ {
+ "$ref": "#/559"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/561"
+ },
+ {
+ "$ref": "#/562"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/tasks@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/503"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/runs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/runs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/566"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/567"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/471"
+ },
+ "flags": 2,
+ "description": "The properties of a run."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/runs@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/568"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deactivate",
+ "resourceType": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "apiVersion": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportImageParameters",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/572"
+ },
+ "flags": 1,
+ "description": "The source of the image."
+ },
+ "targetTags": {
+ "type": {
+ "$ref": "#/574"
+ },
+ "flags": 0,
+ "description": "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)."
+ },
+ "untaggedTargetRepositories": {
+ "type": {
+ "$ref": "#/575"
+ },
+ "flags": 0,
+ "description": "List of strings of repository names to do a manifest only copy. No tag will be created."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/578"
+ },
+ "flags": 0,
+ "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportSource",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource identifier of the source Azure Container Registry."
+ },
+ "registryUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The address of the source registry (e.g. 'mcr.microsoft.com')."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/573"
+ },
+ "flags": 0,
+ "description": "Credentials used when importing from a registry uri."
+ },
+ "sourceImage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123')."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportSourceCredentials",
+ "properties": {
+ "username": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The username to authenticate with the source registry."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The password used to authenticate with the source registry."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoForce"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Force"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/576"
+ },
+ {
+ "$ref": "#/577"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "importImage",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-03-01-preview",
+ "input": {
+ "$ref": "#/571"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegistryListCredentialsResult",
+ "properties": {
+ "username": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The username for a container registry."
+ },
+ "passwords": {
+ "type": {
+ "$ref": "#/585"
+ },
+ "flags": 0,
+ "description": "The list of passwords for a container registry."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegistryPassword",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/584"
+ },
+ "flags": 0,
+ "description": "The password name."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The password value."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/582"
+ },
+ {
+ "$ref": "#/583"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/581"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredentials",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/580"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegenerateCredentialParameters",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/590"
+ },
+ "flags": 1,
+ "description": "Specifies name of the password which should be regenerated -- password or password2."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/588"
+ },
+ {
+ "$ref": "#/589"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateCredential",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/580"
+ },
+ "input": {
+ "$ref": "#/587"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GenerateCredentialsParameters",
+ "properties": {
+ "tokenId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the token for which credentials have to be generated."
+ },
+ "expiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The expiry date of the generated credentials after which the credentials become invalid."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/595"
+ },
+ "flags": 0,
+ "description": "Specifies name of the password which should be regenerated if any -- password1 or password2."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/593"
+ },
+ {
+ "$ref": "#/594"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GenerateCredentialsResult",
+ "properties": {
+ "username": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The username for a container registry."
+ },
+ "passwords": {
+ "type": {
+ "$ref": "#/597"
+ },
+ "flags": 0,
+ "description": "The list of passwords for a container registry."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/363"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "generateCredentials",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/596"
+ },
+ "input": {
+ "$ref": "#/592"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "scheduleRun",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/470"
+ },
+ "input": {
+ "$ref": "#/425"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceUploadDefinition",
+ "properties": {
+ "uploadUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL where the client can upload the source."
+ },
+ "relativePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The relative path to the source. This is used to submit the subsequent queue build request."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listBuildSourceUploadUrl",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/600"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventInfo",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event ID."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "ping",
+ "resourceType": "Microsoft.ContainerRegistry/registries/webhooks",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/602"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventListResult",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/615"
+ },
+ "flags": 0,
+ "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events."
+ },
+ "nextLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URI that can be used to request the next list of events."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Event",
+ "properties": {
+ "eventRequestMessage": {
+ "type": {
+ "$ref": "#/606"
+ },
+ "flags": 0,
+ "description": "The event request message sent to the service URI."
+ },
+ "eventResponseMessage": {
+ "type": {
+ "$ref": "#/613"
+ },
+ "flags": 0,
+ "description": "The event response message received from the service URI."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event ID."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventRequestMessage",
+ "properties": {
+ "content": {
+ "type": {
+ "$ref": "#/607"
+ },
+ "flags": 0,
+ "description": "The content of the event request message."
+ },
+ "headers": {
+ "type": {
+ "$ref": "#/612"
+ },
+ "flags": 0,
+ "description": "The headers of the event request message."
+ },
+ "method": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP method used to send the event request message."
+ },
+ "requestUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URI used to send the event request message."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP message version."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventContent",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event ID."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time at which the event occurred."
+ },
+ "action": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The action that encompasses the provided event."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/608"
+ },
+ "flags": 0,
+ "description": "The target of the event."
+ },
+ "request": {
+ "type": {
+ "$ref": "#/609"
+ },
+ "flags": 0,
+ "description": "The request that generated the event."
+ },
+ "actor": {
+ "type": {
+ "$ref": "#/610"
+ },
+ "flags": 0,
+ "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request."
+ },
+ "source": {
+ "type": {
+ "$ref": "#/611"
+ },
+ "flags": 0,
+ "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Target",
+ "properties": {
+ "mediaType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The MIME type of the referenced object."
+ },
+ "size": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The number of bytes of the content. Same as Length field."
+ },
+ "digest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification."
+ },
+ "length": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The number of bytes of the content. Same as Size field."
+ },
+ "repository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The repository name."
+ },
+ "url": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The direct URL to the content."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The tag name."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the artifact."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of the artifact."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Request",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the request that initiated the event."
+ },
+ "addr": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request."
+ },
+ "host": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests."
+ },
+ "method": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The request method that generated the event."
+ },
+ "useragent": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The user agent header of the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Actor",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The subject or username associated with the request context that generated the event."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Source",
+ "properties": {
+ "addr": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port."
+ },
+ "instanceID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The running instance of an application. Changes after each restart."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventRequestMessageHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventResponseMessage",
+ "properties": {
+ "content": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The content of the event response message."
+ },
+ "headers": {
+ "type": {
+ "$ref": "#/614"
+ },
+ "flags": 0,
+ "description": "The headers of the event response message."
+ },
+ "reasonPhrase": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The reason phrase of the event response message."
+ },
+ "statusCode": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The status code of the event response message."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP message version."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventResponseMessageHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/605"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listEvents",
+ "resourceType": "Microsoft.ContainerRegistry/registries/webhooks",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/604"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CallbackConfig",
+ "properties": {
+ "serviceUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The service URI for the webhook to post notifications."
+ },
+ "customHeaders": {
+ "type": {
+ "$ref": "#/618"
+ },
+ "flags": 0,
+ "description": "Custom headers that will be added to the webhook notifications."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CallbackConfigCustomHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "getCallbackConfig",
+ "resourceType": "Microsoft.ContainerRegistry/registries/webhooks",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/617"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolQueueStatus",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The number of pending runs in the queue"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listQueueStatus",
+ "resourceType": "Microsoft.ContainerRegistry/registries/agentPools",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/620"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunGetLogResult",
+ "properties": {
+ "logLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The link to logs for a run on a azure container registry."
+ },
+ "logArtifactLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The link to logs in registry for a run on a azure container registry."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listLogSasUrl",
+ "resourceType": "Microsoft.ContainerRegistry/registries/runs",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/622"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancel",
+ "resourceType": "Microsoft.ContainerRegistry/registries/runs",
+ "apiVersion": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TaskRun",
+ "properties": {
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 0,
+ "description": "The properties associated with the task run, i.e., request and result of the run"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource ID."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listDetails",
+ "resourceType": "Microsoft.ContainerRegistry/registries/taskRuns",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/625"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Task",
+ "properties": {
+ "identity": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/504"
+ },
+ "flags": 0,
+ "description": "The properties of a task."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource ID."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/628"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listDetails",
+ "resourceType": "Microsoft.ContainerRegistry/registries/tasks",
+ "apiVersion": "2025-03-01-preview",
+ "output": {
+ "$ref": "#/627"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/containerregistry/microsoft.containerregistry/2025-04-01/types.json b/internal/azure/generated/containerregistry/microsoft.containerregistry/2025-04-01/types.json
new file mode 100644
index 000000000..df9f8c1bc
--- /dev/null
+++ b/internal/azure/generated/containerregistry/microsoft.containerregistry/2025-04-01/types.json
@@ -0,0 +1,4167 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 50,
+ "pattern": "^[a-zA-Z0-9-]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/cacheRules"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The properties of the cache rule."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CacheRuleProperties",
+ "properties": {
+ "credentialSetResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ARM resource ID of the credential store which is associated with the cache rule."
+ },
+ "sourceRepository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Source repository pulled from upstream."
+ },
+ "targetRepository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of the cache rule."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource modification (UTC)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/15"
+ },
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/cacheRules@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 50,
+ "pattern": "^[a-zA-Z0-9]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/connectedRegistries"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "The properties of the connected registry."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectedRegistryProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/36"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/41"
+ },
+ "flags": 1,
+ "description": "The mode of the connected registry resource that indicates the permissions of the registry."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current version of ACR runtime on the connected registry."
+ },
+ "connectionState": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 2,
+ "description": "The current connection state of the connected registry."
+ },
+ "lastActivityTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The last activity time of the connected registry."
+ },
+ "activation": {
+ "type": {
+ "$ref": "#/47"
+ },
+ "flags": 2,
+ "description": "The activation properties of the connected registry."
+ },
+ "parent": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 1,
+ "description": "The parent of the connected registry."
+ },
+ "clientTokenIds": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry."
+ },
+ "loginServer": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "The login server properties of the connected registry."
+ },
+ "logging": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 0,
+ "description": "The logging properties of the connected registry."
+ },
+ "statusDetails": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 2,
+ "description": "The list of current statuses of the connected registry."
+ },
+ "notificationsList": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 0,
+ "description": "The list of notifications subscription information for the connected registry."
+ },
+ "garbageCollection": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "The garbage collection properties of the connected registry."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/30"
+ },
+ {
+ "$ref": "#/31"
+ },
+ {
+ "$ref": "#/32"
+ },
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadWrite"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Registry"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mirror"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Offline"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Syncing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unhealthy"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ActivationProperties",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/50"
+ },
+ "flags": 2,
+ "description": "The activation status of the connected registry."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Inactive"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ParentProperties",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the parent to which the connected registry will be associated."
+ },
+ "syncProperties": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "The sync properties of the connected registry with its parent."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SyncProperties",
+ "properties": {
+ "tokenId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of the ACR token used to authenticate the connected registry to its parent during sync."
+ },
+ "schedule": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The cron expression indicating the schedule that the connected registry will sync with its parent."
+ },
+ "syncWindow": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "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."
+ },
+ "messageTtl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "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."
+ },
+ "lastSyncTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The last time a sync occurred between the connected registry and its parent."
+ },
+ "gatewayEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The gateway endpoint used by the connected registry to communicate with its parent."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LoginServerProperties",
+ "properties": {
+ "host": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The host of the connected registry. Can be FQDN or IP."
+ },
+ "tls": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 2,
+ "description": "The TLS properties of the connected registry login server."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TlsProperties",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 2,
+ "description": "Indicates whether HTTPS is enabled for the login server."
+ },
+ "certificate": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 2,
+ "description": "The certificate used to configure HTTPS for the login server."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TlsCertificateProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 2,
+ "description": "The type of certificate location."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Indicates the location of the certificates."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LocalDirectory"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LoggingProperties",
+ "properties": {
+ "logLevel": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "The verbosity of logs persisted on the connected registry."
+ },
+ "auditLogStatus": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 0,
+ "description": "Indicates whether audit logs are enabled on the connected registry."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Debug"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Information"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "StatusDetailProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The component of the connected registry corresponding to the status."
+ },
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The code of the status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The description of the status."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp of the status."
+ },
+ "correlationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The correlation ID of the status."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/72"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GarbageCollectionProperties",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "Indicates whether garbage collection is enabled for the connected registry."
+ },
+ "schedule": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The cron expression indicating the schedule that the connected registry will run garbage collection."
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/connectedRegistries@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/28"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/credentialSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Identities associated with the resource. This is used to access the KeyVault secrets."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "The properties of the credential set."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IdentityProperties",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal ID of resource identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant ID of resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 0,
+ "description": "The identity type."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned, UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserIdentityProperties",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IdentityPropertiesUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/87"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialSetProperties",
+ "properties": {
+ "loginServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The credentials are stored for this upstream or login server."
+ },
+ "authCredentials": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of credential store resource."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AuthCredential",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "The name of the credential."
+ },
+ "usernameSecretIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "KeyVault Secret URI for accessing the username."
+ },
+ "passwordSecretIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "KeyVault Secret URI for accessing the password."
+ },
+ "credentialHealth": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "This provides data pertaining to the health of the auth credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Credential1"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/91"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialHealth",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 0,
+ "description": "The health status of credential."
+ },
+ "errorCode": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error code representing the health check error."
+ },
+ "errorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Descriptive message representing the health check error."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Healthy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unhealthy"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/94"
+ },
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/90"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/98"
+ },
+ {
+ "$ref": "#/99"
+ },
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/credentialSets@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/80"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 1,
+ "description": "The SKU of the container registry."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "The identity of the container registry."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 0,
+ "description": "The properties of the container registry."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Sku",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 1,
+ "description": "The SKU name of the container registry. Required for registry creation."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 2,
+ "description": "The SKU tier based on the SKU name."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Classic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Classic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/115"
+ },
+ {
+ "$ref": "#/116"
+ },
+ {
+ "$ref": "#/117"
+ },
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegistryProperties",
+ "properties": {
+ "loginServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The URL that can be used to log into the container registry."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of the container registry in ISO8601 format."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the container registry at the time the operation was called."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/128"
+ },
+ "flags": 2,
+ "description": "The status of the container registry at the time the operation was called."
+ },
+ "adminUserEnabled": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the admin user is enabled."
+ },
+ "networkRuleSet": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 0,
+ "description": "The network rule set for a container registry."
+ },
+ "policies": {
+ "type": {
+ "$ref": "#/137"
+ },
+ "flags": 0,
+ "description": "The policies for a container registry."
+ },
+ "encryption": {
+ "type": {
+ "$ref": "#/161"
+ },
+ "flags": 0,
+ "description": "The encryption settings of container registry."
+ },
+ "dataEndpointEnabled": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "Enable a single data endpoint per region for serving data."
+ },
+ "dataEndpointHostNames": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 2,
+ "description": "List of host names that will serve data when dataEndpointEnabled is true."
+ },
+ "privateEndpointConnections": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 2,
+ "description": "List of private endpoint connections for a container registry."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 0,
+ "description": "Whether or not public network access is allowed for the container registry."
+ },
+ "networkRuleBypassOptions": {
+ "type": {
+ "$ref": "#/192"
+ },
+ "flags": 0,
+ "description": "Whether to allow trusted Azure services to access a network restricted registry."
+ },
+ "zoneRedundancy": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Whether or not zone redundancy is enabled for this container registry"
+ },
+ "anonymousPullEnabled": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "Enables registry-wide pull from unauthenticated clients."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/121"
+ },
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/124"
+ },
+ {
+ "$ref": "#/125"
+ },
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Status",
+ "properties": {
+ "displayStatus": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The short label for the status."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The detailed message for the status, including alerts and error messages."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp when the status was changed to the current value."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkRuleSet",
+ "properties": {
+ "defaultAction": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 1,
+ "description": "The default action of allow or deny when no other rules match."
+ },
+ "ipRules": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 0,
+ "description": "The IP ACL rules."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Allow"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deny"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IPRule",
+ "properties": {
+ "action": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "The action of IP ACL rule."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Allow"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/134"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/133"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Policies",
+ "properties": {
+ "quarantinePolicy": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "The quarantine policy for a container registry."
+ },
+ "trustPolicy": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 0,
+ "description": "The content trust policy for a container registry."
+ },
+ "retentionPolicy": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The retention policy for a container registry."
+ },
+ "exportPolicy": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 0,
+ "description": "The export policy for a container registry."
+ },
+ "azureADAuthenticationAsArmPolicy": {
+ "type": {
+ "$ref": "#/157"
+ },
+ "flags": 0,
+ "description": "The policy for using ARM audience token for a container registry."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QuarantinePolicy",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/139"
+ },
+ {
+ "$ref": "#/140"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrustPolicy",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "The type of trust policy."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Notary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetentionPolicy",
+ "properties": {
+ "days": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "The number of days to retain an untagged manifest after which it gets purged."
+ },
+ "lastUpdatedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The timestamp when the policy was last updated."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportPolicy",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/154"
+ },
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureADAuthenticationAsArmPolicy",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 0,
+ "description": "The value that indicates whether the policy is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/159"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionProperty",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/164"
+ },
+ "flags": 0,
+ "description": "Indicates whether or not the encryption is enabled for container registry."
+ },
+ "keyVaultProperties": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "Key vault properties."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/162"
+ },
+ {
+ "$ref": "#/163"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyVaultProperties",
+ "properties": {
+ "keyIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Key vault uri to access the encryption key."
+ },
+ "versionedKeyIdentifier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The fully qualified key identifier that includes the version of the key that is actually used for encryption."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client id of the identity which will be used to access key vault."
+ },
+ "keyRotationEnabled": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 2,
+ "description": "Auto key rotation status for a CMK enabled registry."
+ },
+ "lastKeyRotationTimestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Timestamp of the last successful key rotation."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnection",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource ID."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/170"
+ },
+ "flags": 0,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 2,
+ "description": "The provisioning state of private endpoint connection resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is private endpoint resource created with Microsoft.Network resource provider."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The description for connection status. For example if connection is rejected it can indicate reason for rejection."
+ },
+ "actionsRequired": {
+ "type": {
+ "$ref": "#/178"
+ },
+ "flags": 0,
+ "description": "A message indicating if changes on the service provider require any updates on the consumer."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Recreate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/176"
+ },
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/179"
+ },
+ {
+ "$ref": "#/180"
+ },
+ {
+ "$ref": "#/181"
+ },
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/184"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/167"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/187"
+ },
+ {
+ "$ref": "#/188"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureServices"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/190"
+ },
+ {
+ "$ref": "#/191"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/194"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/108"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/privateEndpointConnections@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/200"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/replications"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/replications",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/202"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/203"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 0,
+ "description": "The properties of the replication."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the resource. This cannot be changed after the resource is created."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 0,
+ "description": "The tags of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReplicationProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the replication at the time the operation was called."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/128"
+ },
+ "flags": 2,
+ "description": "The status of the replication at the time the operation was called."
+ },
+ "regionEndpointEnabled": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "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."
+ },
+ "zoneRedundancy": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "Whether or not zone redundancy is enabled for this container registry replication"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/206"
+ },
+ {
+ "$ref": "#/207"
+ },
+ {
+ "$ref": "#/208"
+ },
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/211"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/213"
+ },
+ {
+ "$ref": "#/214"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/replications@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/204"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 5,
+ "maxLength": 50,
+ "pattern": "^[a-zA-Z0-9-_]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/scopeMaps"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/222"
+ },
+ "flags": 0,
+ "description": "The properties of the scope map."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScopeMapProperties",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The user friendly description of the scope map."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the scope map. E.g. BuildIn scope map."
+ },
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of scope map."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ },
+ "actions": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 1,
+ "description": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/223"
+ },
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/226"
+ },
+ {
+ "$ref": "#/227"
+ },
+ {
+ "$ref": "#/228"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/scopeMaps@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/221"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/tokens"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "The properties of the token."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenProperties",
+ "properties": {
+ "creationDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The creation date of scope map."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ },
+ "scopeMapId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the scope map to which the token will be associated with."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 0,
+ "description": "The credentials that can be used for authenticating the token."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 0,
+ "description": "The status of the token example enabled or disabled."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/236"
+ },
+ {
+ "$ref": "#/237"
+ },
+ {
+ "$ref": "#/238"
+ },
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/240"
+ },
+ {
+ "$ref": "#/241"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenCredentialsProperties",
+ "properties": {
+ "certificates": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0
+ },
+ "passwords": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenCertificate",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/247"
+ },
+ "flags": 0
+ },
+ "expiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The expiry datetime of the certificate."
+ },
+ "thumbprint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The thumbprint of the certificate."
+ },
+ "encodedPemCertificate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "certificate1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "certificate2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/245"
+ },
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/244"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TokenPassword",
+ "properties": {
+ "creationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The creation datetime of the password."
+ },
+ "expiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The expiry datetime of the password."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "The password name \"password1\" or \"password2\""
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The password value."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/250"
+ },
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/249"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/254"
+ },
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/tokens@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/234"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerRegistry/registries/webhooks"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerRegistry/registries/webhooks",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "The tags for the webhook."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The location of the webhook. This cannot be changed after the resource is created."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 0,
+ "description": "The properties that the webhook will be created with."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WebhookCreateParametersTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WebhookPropertiesCreateParametersOrWebhookProperties",
+ "properties": {
+ "serviceUri": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 5,
+ "description": "The service URI for the webhook to post notifications."
+ },
+ "customHeaders": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 4,
+ "description": "Custom headers that will be added to the webhook notifications."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 0,
+ "description": "The status of the webhook at the time the operation was called."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "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."
+ },
+ "actions": {
+ "type": {
+ "$ref": "#/274"
+ },
+ "flags": 1,
+ "description": "The list of actions that trigger the webhook to post notifications."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the webhook at the time the operation was called."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WebhookPropertiesCreateParametersCustomHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "push"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "quarantine"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "chart_push"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "chart_delete"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/269"
+ },
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/272"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/273"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/275"
+ },
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/277"
+ },
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerRegistry/registries/webhooks@2025-04-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/260"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deactivate",
+ "resourceType": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "apiVersion": "2025-04-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportImageParameters",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 1,
+ "description": "The source of the image."
+ },
+ "targetTags": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 0,
+ "description": "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)."
+ },
+ "untaggedTargetRepositories": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 0,
+ "description": "List of strings of repository names to do a manifest only copy. No tag will be created."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportSource",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource identifier of the source Azure Container Registry."
+ },
+ "registryUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The address of the source registry (e.g. 'mcr.microsoft.com')."
+ },
+ "credentials": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 0,
+ "description": "Credentials used when importing from a registry uri."
+ },
+ "sourceImage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123')."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImportSourceCredentials",
+ "properties": {
+ "username": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The username to authenticate with the source registry."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The password used to authenticate with the source registry."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoForce"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Force"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/289"
+ },
+ {
+ "$ref": "#/290"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "importImage",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-04-01",
+ "input": {
+ "$ref": "#/284"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegistryListCredentialsResult",
+ "properties": {
+ "username": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The username for a container registry."
+ },
+ "passwords": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 0,
+ "description": "The list of passwords for a container registry."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegistryPassword",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 0,
+ "description": "The password name."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The password value."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/296"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/294"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredentials",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-04-01",
+ "output": {
+ "$ref": "#/293"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegenerateCredentialParameters",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 1,
+ "description": "Specifies name of the password which should be regenerated -- password or password2."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/301"
+ },
+ {
+ "$ref": "#/302"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateCredential",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-04-01",
+ "output": {
+ "$ref": "#/293"
+ },
+ "input": {
+ "$ref": "#/300"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GenerateCredentialsParameters",
+ "properties": {
+ "tokenId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the token for which credentials have to be generated."
+ },
+ "expiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The expiry date of the generated credentials after which the credentials become invalid."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 0,
+ "description": "Specifies name of the password which should be regenerated if any -- password1 or password2."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password1"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "password2"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/306"
+ },
+ {
+ "$ref": "#/307"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GenerateCredentialsResult",
+ "properties": {
+ "username": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The username for a container registry."
+ },
+ "passwords": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "The list of passwords for a container registry."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/249"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "generateCredentials",
+ "resourceType": "Microsoft.ContainerRegistry/registries",
+ "apiVersion": "2025-04-01",
+ "output": {
+ "$ref": "#/309"
+ },
+ "input": {
+ "$ref": "#/305"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventInfo",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event ID."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "ping",
+ "resourceType": "Microsoft.ContainerRegistry/registries/webhooks",
+ "apiVersion": "2025-04-01",
+ "output": {
+ "$ref": "#/312"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventListResult",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 0,
+ "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events."
+ },
+ "nextLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URI that can be used to request the next list of events."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Event",
+ "properties": {
+ "eventRequestMessage": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 0,
+ "description": "The event request message sent to the service URI."
+ },
+ "eventResponseMessage": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 0,
+ "description": "The event response message received from the service URI."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event ID."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventRequestMessage",
+ "properties": {
+ "content": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 0,
+ "description": "The content of the event request message."
+ },
+ "headers": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 0,
+ "description": "The headers of the event request message."
+ },
+ "method": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP method used to send the event request message."
+ },
+ "requestUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URI used to send the event request message."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP message version."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventContent",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The event ID."
+ },
+ "timestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time at which the event occurred."
+ },
+ "action": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The action that encompasses the provided event."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 0,
+ "description": "The target of the event."
+ },
+ "request": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "The request that generated the event."
+ },
+ "actor": {
+ "type": {
+ "$ref": "#/320"
+ },
+ "flags": 0,
+ "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request."
+ },
+ "source": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 0,
+ "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Target",
+ "properties": {
+ "mediaType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The MIME type of the referenced object."
+ },
+ "size": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "The number of bytes of the content. Same as Length field."
+ },
+ "digest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification."
+ },
+ "length": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "The number of bytes of the content. Same as Size field."
+ },
+ "repository": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The repository name."
+ },
+ "url": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The direct URL to the content."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The tag name."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the artifact."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of the artifact."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Request",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the request that initiated the event."
+ },
+ "addr": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request."
+ },
+ "host": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests."
+ },
+ "method": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The request method that generated the event."
+ },
+ "useragent": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The user agent header of the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Actor",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The subject or username associated with the request context that generated the event."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Source",
+ "properties": {
+ "addr": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port."
+ },
+ "instanceID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The running instance of an application. Changes after each restart."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventRequestMessageHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventResponseMessage",
+ "properties": {
+ "content": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The content of the event response message."
+ },
+ "headers": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 0,
+ "description": "The headers of the event response message."
+ },
+ "reasonPhrase": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The reason phrase of the event response message."
+ },
+ "statusCode": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The status code of the event response message."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP message version."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EventResponseMessageHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/315"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listEvents",
+ "resourceType": "Microsoft.ContainerRegistry/registries/webhooks",
+ "apiVersion": "2025-04-01",
+ "output": {
+ "$ref": "#/314"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CallbackConfig",
+ "properties": {
+ "serviceUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The service URI for the webhook to post notifications."
+ },
+ "customHeaders": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 0,
+ "description": "Custom headers that will be added to the webhook notifications."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CallbackConfigCustomHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "getCallbackConfig",
+ "resourceType": "Microsoft.ContainerRegistry/registries/webhooks",
+ "apiVersion": "2025-04-01",
+ "output": {
+ "$ref": "#/327"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/containerservice/microsoft.containerservice/2024-10-01/types.json b/internal/azure/generated/containerservice/microsoft.containerservice/2024-10-01/types.json
index 1ff9ef1fd..69809e0ea 100644
--- a/internal/azure/generated/containerservice/microsoft.containerservice/2024-10-01/types.json
+++ b/internal/azure/generated/containerservice/microsoft.containerservice/2024-10-01/types.json
@@ -716,7 +716,7 @@
"$ref": "#/2"
},
"flags": 0,
- "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
},
"osDiskSizeGB": {
"type": {
@@ -5109,7 +5109,7 @@
"$ref": "#/2"
},
"flags": 0,
- "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
},
"osDiskSizeGB": {
"type": {
diff --git a/internal/azure/generated/containerservice/microsoft.containerservice/2025-01-01/types.json b/internal/azure/generated/containerservice/microsoft.containerservice/2025-01-01/types.json
new file mode 100644
index 000000000..02039a991
--- /dev/null
+++ b/internal/azure/generated/containerservice/microsoft.containerservice/2025-01-01/types.json
@@ -0,0 +1,7199 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The managed cluster SKU."
+ },
+ "extendedLocation": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "The extended location of the Virtual Machine."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The identity of the managed cluster, if configured."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "Properties of a managed cluster."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSKU",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The name of a managed cluster SKU."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Base"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Free"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExtendedLocation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EdgeZone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of the system assigned identity which is used by master components."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant id of the system assigned identity which is used by master components."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 0,
+ "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity)."
+ },
+ "delegatedResources": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 0,
+ "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResource",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ARM resource id of the delegated resource - internal use only."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 0,
+ "description": "The tenant id of the delegated resource - internal use only."
+ },
+ "referralResource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The delegation id of the referral delegation (optional) - internal use only."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source resource location - internal use only."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResources",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/20"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/23"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 2,
+ "description": "The Power State of the cluster."
+ },
+ "maxAgentPools": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 2,
+ "description": "The max number of agent pools for the managed cluster."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details."
+ },
+ "currentKubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used."
+ },
+ "dnsPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdnSubdomain": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of the master pool."
+ },
+ "privateFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of private cluster."
+ },
+ "azurePortalFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly."
+ },
+ "agentPoolProfiles": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The agent pool properties."
+ },
+ "linuxProfile": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "The profile for Linux VMs in the Managed Cluster."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/112"
+ },
+ "flags": 0,
+ "description": "The profile for Windows VMs in the Managed Cluster."
+ },
+ "servicePrincipalProfile": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs."
+ },
+ "addonProfiles": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The profile of managed cluster add-on."
+ },
+ "podIdentityProfile": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 0,
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration."
+ },
+ "oidcIssuerProfile": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "nodeResourceGroup": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the resource group containing agent pool nodes."
+ },
+ "nodeResourceGroupProfile": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "Profile of the node resource group configuration."
+ },
+ "enableRBAC": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Kubernetes Role-Based Access Control."
+ },
+ "supportPlan": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'."
+ },
+ "enablePodSecurityPolicy": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The network configuration profile."
+ },
+ "aadProfile": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 0,
+ "description": "The Azure Active Directory configuration."
+ },
+ "autoUpgradeProfile": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "The auto upgrade configuration."
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading a cluster."
+ },
+ "autoScalerProfile": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "Parameters to be applied to the cluster-autoscaler when enabled"
+ },
+ "apiServerAccessProfile": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "The access profile for managed cluster API server."
+ },
+ "diskEncryptionSetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'"
+ },
+ "identityProfile": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is \"kubeletidentity\", with value of \"resourceId\": \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}\"."
+ },
+ "privateLinkResources": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 0,
+ "description": "Private link resources associated with the cluster."
+ },
+ "disableLocalAccounts": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)."
+ },
+ "httpProxyConfig": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 0,
+ "description": "Configurations for provisioning the cluster with HTTP proxy servers."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "Security profile for the managed cluster."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/246"
+ },
+ "flags": 0,
+ "description": "Storage profile for the managed cluster."
+ },
+ "ingressProfile": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 0,
+ "description": "Ingress profile for the managed cluster."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 0,
+ "description": "Allow or deny public network access for AKS"
+ },
+ "workloadAutoScalerProfile": {
+ "type": {
+ "$ref": "#/257"
+ },
+ "flags": 0,
+ "description": "Workload Auto-scaler profile for the managed cluster."
+ },
+ "azureMonitorProfile": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 0,
+ "description": "Azure Monitor addon profiles for monitoring the managed cluster."
+ },
+ "serviceMeshProfile": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 0,
+ "description": "Service mesh profile for a managed cluster."
+ },
+ "resourceUID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)"
+ },
+ "metricsProfile": {
+ "type": {
+ "$ref": "#/279"
+ },
+ "flags": 0,
+ "description": "Optional cluster metrics configuration."
+ },
+ "bootstrapProfile": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster bootstrap configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PowerState",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Tells whether the cluster is Running or Stopped"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/27"
+ },
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfile",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 1,
+ "description": "Windows agent pool names must be 6 characters or less."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/36"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 0,
+ "description": "GPU settings for the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 2048
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/53"
+ },
+ {
+ "$ref": "#/54"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/59"
+ },
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolUpgradeSettings",
+ "properties": {
+ "maxSurge": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
+ },
+ "drainTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes."
+ },
+ "nodeSoakDurationInMinutes": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 1440
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 30
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubeletConfig",
+ "properties": {
+ "cpuManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'."
+ },
+ "cpuCfsQuota": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "cpuCfsQuotaPeriod": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'."
+ },
+ "imageGcHighThreshold": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "To disable image garbage collection, set to 100. The default is 85%"
+ },
+ "imageGcLowThreshold": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%"
+ },
+ "topologyManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'."
+ },
+ "allowedUnsafeSysctls": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)."
+ },
+ "failSwapOn": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node."
+ },
+ "containerLogMaxSizeMB": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated."
+ },
+ "containerLogMaxFiles": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2."
+ },
+ "podMaxPids": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of processes per pod."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxOSConfig",
+ "properties": {
+ "sysctls": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 0,
+ "description": "Sysctl settings for Linux agent nodes."
+ },
+ "transparentHugePageEnabled": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "transparentHugePageDefrag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "swapFileSizeMB": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The size in MB of a swap file that will be created on each node."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SysctlConfig",
+ "properties": {
+ "netCoreSomaxconn": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.somaxconn."
+ },
+ "netCoreNetdevMaxBacklog": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.netdev_max_backlog."
+ },
+ "netCoreRmemDefault": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_default."
+ },
+ "netCoreRmemMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_max."
+ },
+ "netCoreWmemDefault": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_default."
+ },
+ "netCoreWmemMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_max."
+ },
+ "netCoreOptmemMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.optmem_max."
+ },
+ "netIpv4TcpMaxSynBacklog": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog."
+ },
+ "netIpv4TcpMaxTwBuckets": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets."
+ },
+ "netIpv4TcpFinTimeout": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_fin_timeout."
+ },
+ "netIpv4TcpKeepaliveTime": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_time."
+ },
+ "netIpv4TcpKeepaliveProbes": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_probes."
+ },
+ "netIpv4TcpkeepaliveIntvl": {
+ "type": {
+ "$ref": "#/80"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl."
+ },
+ "netIpv4TcpTwReuse": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_tw_reuse."
+ },
+ "netIpv4IpLocalPortRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.ip_local_port_range."
+ },
+ "netIpv4NeighDefaultGcThresh1": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1."
+ },
+ "netIpv4NeighDefaultGcThresh2": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2."
+ },
+ "netIpv4NeighDefaultGcThresh3": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3."
+ },
+ "netNetfilterNfConntrackMax": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_max."
+ },
+ "netNetfilterNfConntrackBuckets": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_buckets."
+ },
+ "fsInotifyMaxUserWatches": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.inotify.max_user_watches."
+ },
+ "fsFileMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.file-max."
+ },
+ "fsAioMaxNr": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.aio-max-nr."
+ },
+ "fsNrOpen": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.nr_open."
+ },
+ "kernelThreadsMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting kernel.threads-max."
+ },
+ "vmMaxMapCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.max_map_count."
+ },
+ "vmSwappiness": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.swappiness."
+ },
+ "vmVfsCachePressure": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.vfs_cache_pressure."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 10,
+ "maxValue": 90
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 131072,
+ "maxValue": 2097152
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 65536,
+ "maxValue": 524288
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreationData",
+ "properties": {
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is the ARM ID of the source object to be used to create the target object."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolNetworkProfile",
+ "properties": {
+ "nodePublicIPTags": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "IPTags of instance-level public IPs."
+ },
+ "allowedHostPorts": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 0,
+ "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap."
+ },
+ "applicationSecurityGroups": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "The IDs of the application security groups which agent pool will associate when created."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IPTag",
+ "properties": {
+ "ipTagType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP tag type. Example: RoutingPreference."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The value of the IP tag associated with the public IP. Example: Internet."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/91"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PortRange",
+ "properties": {
+ "portStart": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd."
+ },
+ "portEnd": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart."
+ },
+ "protocol": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "The network protocol of the port."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 65535
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TCP"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UDP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/96"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/93"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolWindowsProfile",
+ "properties": {
+ "disableOutboundNat": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolSecurityProfile",
+ "properties": {
+ "enableVTPM": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ },
+ "enableSecureBoot": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GPUProfile",
+ "properties": {
+ "driver": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "Whether to install GPU drivers. When it's not specified, default is Install."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Install"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/31"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceLinuxProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 1,
+ "description": "The administrator username to use for Linux VMs."
+ },
+ "ssh": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 1,
+ "description": "The SSH configuration for Linux-based VMs running on Azure."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshConfiguration",
+ "properties": {
+ "publicKeys": {
+ "type": {
+ "$ref": "#/111"
+ },
+ "flags": 1,
+ "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshPublicKey",
+ "properties": {
+ "keyData": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/110"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWindowsProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Specifies the name of the administrator account.
**Max-length:** 20 characters"
+ },
+ "adminPassword": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length:** 8 characters
**Max-length:** 123 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\""
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details."
+ },
+ "enableCSIProxy": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)."
+ },
+ "gmsaProfile": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "The Windows gMSA Profile in the Managed Cluster."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows_Server"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/114"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsGmsaProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Specifies whether to enable Windows gMSA in the managed cluster."
+ },
+ "dnsServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the DNS server for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ },
+ "rootDomainName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the root domain name for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterServicePrincipalProfile",
+ "properties": {
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ID for the service principal."
+ },
+ "secret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The secret password associated with the service principal in plain text."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether the add-on is enabled or not."
+ },
+ "config": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 0,
+ "description": "Key-value pairs for configuring an add-on."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 2,
+ "description": "Information of user assigned identity used by this add-on."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileConfig",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAddonProfiles",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/118"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether the pod identity addon is enabled."
+ },
+ "allowNetworkPluginKubenet": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 0,
+ "description": "The pod identities to use in the cluster."
+ },
+ "userAssignedIdentityExceptions": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 0,
+ "description": "The pod identity exceptions to allow."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentity",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity."
+ },
+ "bindingSelector": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The binding selector to use for the AzureIdentityBinding resource."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 1,
+ "description": "The user assigned identity details."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/131"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of the pod identity."
+ },
+ "provisioningInfo": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Assigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/125"
+ },
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/128"
+ },
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningInfo",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 0,
+ "description": "Pod identity assignment error (if any)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningErrorBody",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "A list of additional details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/134"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/123"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityException",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity exception."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity exception."
+ },
+ "podLabels": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 1,
+ "description": "The pod labels to match."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityExceptionPodLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/137"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterOidcIssuerProfile",
+ "properties": {
+ "issuerURL": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The OIDC issuer url of the Managed Cluster."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether the OIDC issuer is enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNodeResourceGroupProfile",
+ "properties": {
+ "restrictionLevel": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unrestricted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesOfficial"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AKSLongTermSupport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfile",
+ "properties": {
+ "networkPlugin": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "networkPluginMode": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 0,
+ "description": "The mode the network plugin should use."
+ },
+ "networkPolicy": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "networkMode": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "networkDataplane": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "Network dataplane used in the Kubernetes cluster."
+ },
+ "advancedNetworking": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 0,
+ "description": "Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking."
+ },
+ "podCidr": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used."
+ },
+ "serviceCidr": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges."
+ },
+ "dnsServiceIP": {
+ "type": {
+ "$ref": "#/170"
+ },
+ "flags": 0,
+ "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr."
+ },
+ "outboundType": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)."
+ },
+ "loadBalancerSku": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 0,
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "loadBalancerProfile": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster load balancer."
+ },
+ "natGatewayProfile": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster NAT gateway."
+ },
+ "podCidrs": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking."
+ },
+ "serviceCidrs": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges."
+ },
+ "ipFamilies": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "kubenet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "overlay"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/153"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "calico"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ },
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "transparent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "bridge"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/163"
+ },
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworking",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false."
+ },
+ "observability": {
+ "type": {
+ "$ref": "#/167"
+ },
+ "flags": 0,
+ "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts."
+ },
+ "security": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "Security profile to enable security features on cilium based cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingObservability",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingSecurity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "loadBalancer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userDefinedRouting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "managedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userAssignedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfile",
+ "properties": {
+ "managedOutboundIPs": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 0,
+ "description": "Desired managed outbound IPs for the cluster load balancer."
+ },
+ "outboundIPPrefixes": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP Prefix resources for the cluster load balancer."
+ },
+ "outboundIPs": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP resources for the cluster load balancer."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster load balancer."
+ },
+ "allocatedOutboundPorts": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 0,
+ "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes."
+ },
+ "enableMultipleStandardLoadBalancers": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Enable multiple standard load balancers per AKS cluster or not."
+ },
+ "backendPoolType": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "The type of the managed inbound Load Balancer BackendPool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileManagedOutboundIPs",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/182"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1."
+ },
+ "countIPv6": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 100
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 100
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPPrefixes",
+ "properties": {
+ "publicIPPrefixes": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 0,
+ "description": "A list of public IP prefix resources."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The fully qualified Azure resource id."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPs",
+ "properties": {
+ "publicIPs": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "A list of public IP resources."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 64000
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 120
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIPConfiguration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNATGatewayProfile",
+ "properties": {
+ "managedOutboundIPProfile": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "Profile of the managed outbound IP resources of the cluster NAT gateway."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster NAT gateway."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterManagedOutboundIPProfile",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/197"
+ },
+ "flags": 0,
+ "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 16
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/201"
+ },
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/203"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAADProfile",
+ "properties": {
+ "managed": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable managed AAD."
+ },
+ "enableAzureRBAC": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure RBAC for Kubernetes authorization."
+ },
+ "adminGroupObjectIDs": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "The list of AAD group object IDs that will have admin role of the cluster."
+ },
+ "clientAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppSecret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "tenantID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAutoUpgradeProfile",
+ "properties": {
+ "upgradeChannel": {
+ "type": {
+ "$ref": "#/213"
+ },
+ "flags": 0,
+ "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)."
+ },
+ "nodeOSUpgradeChannel": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 0,
+ "description": "Manner in which the OS on your nodes is updated. The default is NodeImage."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "rapid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "stable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "patch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "node-image"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/208"
+ },
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/211"
+ },
+ {
+ "$ref": "#/212"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unmanaged"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeImage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecurityPatch"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/214"
+ },
+ {
+ "$ref": "#/215"
+ },
+ {
+ "$ref": "#/216"
+ },
+ {
+ "$ref": "#/217"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterUpgradeSettings",
+ "properties": {
+ "overrideSettings": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 0,
+ "description": "Settings for overrides."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpgradeOverrideSettings",
+ "properties": {
+ "forceUpgrade": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution."
+ },
+ "until": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAutoScalerProfile",
+ "properties": {
+ "balance-similar-node-groups": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'true' and 'false'"
+ },
+ "daemonset-eviction-for-empty-nodes": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "daemonset-eviction-for-occupied-nodes": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "ignore-daemonsets-utilization": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions."
+ },
+ "expander": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information."
+ },
+ "max-empty-bulk-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 10."
+ },
+ "max-graceful-termination-sec": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 600."
+ },
+ "max-node-provision-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "max-total-unready-percentage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 45. The maximum is 100 and the minimum is 0."
+ },
+ "new-pod-scale-up-delay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)."
+ },
+ "ok-total-unready-count": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This must be an integer. The default is 3."
+ },
+ "scan-interval": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10'. Values must be an integer number of seconds."
+ },
+ "scale-down-delay-after-add": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-failure": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unneeded-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unready-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-utilization-threshold": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '0.5'."
+ },
+ "skip-nodes-with-local-storage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "skip-nodes-with-system-pods": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "least-waste"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "most-pods"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "priority"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "random"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/222"
+ },
+ {
+ "$ref": "#/223"
+ },
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAPIServerAccessProfile",
+ "properties": {
+ "authorizedIPRanges": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)."
+ },
+ "enablePrivateCluster": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)."
+ },
+ "privateDNSZone": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'."
+ },
+ "enablePrivateClusterPublicFQDN": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to create additional public FQDN for private cluster or not."
+ },
+ "disableRunCommand": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to disable run command for the cluster or not."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesIdentityProfile",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/124"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the private link resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the private link resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource type."
+ },
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The group ID of the resource."
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "The RequiredMembers of the resource"
+ },
+ "privateLinkServiceID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The private link service ID of the resource, this field is exposed only to NRP internally."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/230"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterHttpProxyConfig",
+ "properties": {
+ "httpProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP proxy server endpoint to use."
+ },
+ "httpsProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTPS proxy server endpoint to use."
+ },
+ "noProxy": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 0,
+ "description": "The endpoints that should not go through proxy."
+ },
+ "trustedCa": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Alternative CA cert to use for connecting to proxy servers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfile",
+ "properties": {
+ "defender": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "azureKeyVaultKms": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 0,
+ "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile."
+ },
+ "workloadIdentity": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 0,
+ "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details."
+ },
+ "imageCleaner": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 0,
+ "description": "Image Cleaner settings for the security profile."
+ },
+ "customCATrustCertificates": {
+ "type": {
+ "$ref": "#/245"
+ },
+ "flags": 0,
+ "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefender",
+ "properties": {
+ "logAnalyticsWorkspaceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty."
+ },
+ "securityMonitoring": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender threat detection for Cloud settings for the security profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityMonitoring",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Defender threat detection"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureKeyVaultKms",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure Key Vault key management service. The default is false."
+ },
+ "keyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
+ },
+ "keyVaultNetworkAccess": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 0,
+ "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`."
+ },
+ "keyVaultResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Public"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Private"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/240"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileWorkloadIdentity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable workload identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileImageCleaner",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Image Cleaner on AKS cluster."
+ },
+ "intervalHours": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Image Cleaner scanning interval in hours."
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/244"
+ },
+ "maxLength": 10
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfile",
+ "properties": {
+ "diskCSIDriver": {
+ "type": {
+ "$ref": "#/247"
+ },
+ "flags": 0,
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "fileCSIDriver": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "snapshotController": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "blobCSIDriver": {
+ "type": {
+ "$ref": "#/250"
+ },
+ "flags": 0,
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileDiskCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureDisk CSI Driver. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileFileCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureFile CSI Driver. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileSnapshotController",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Snapshot Controller. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileBlobCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureBlob CSI Driver. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfile",
+ "properties": {
+ "webAppRouting": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileWebAppRouting",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable the Application Routing add-on."
+ },
+ "dnsZoneResourceIds": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 2,
+ "description": "Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 5
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/254"
+ },
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfile",
+ "properties": {
+ "keda": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 0,
+ "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile."
+ },
+ "verticalPodAutoscaler": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileKeda",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable KEDA."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable VPA. Default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfile",
+ "properties": {
+ "metrics": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileMetrics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling."
+ },
+ "kubeStateMetrics": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 0,
+ "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileKubeStateMetrics",
+ "properties": {
+ "metricLabelsAllowlist": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels."
+ },
+ "metricAnnotationsAllowList": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServiceMeshProfile",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/266"
+ },
+ "flags": 1,
+ "description": "Mode of the service mesh."
+ },
+ "istio": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 0,
+ "description": "Istio service mesh configuration."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Istio"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/264"
+ },
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioServiceMesh",
+ "properties": {
+ "components": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 0,
+ "description": "Istio components configuration."
+ },
+ "certificateAuthority": {
+ "type": {
+ "$ref": "#/276"
+ },
+ "flags": 0,
+ "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca"
+ },
+ "revisions": {
+ "type": {
+ "$ref": "#/278"
+ },
+ "flags": 0,
+ "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioComponents",
+ "properties": {
+ "ingressGateways": {
+ "type": {
+ "$ref": "#/273"
+ },
+ "flags": 0,
+ "description": "Istio ingress gateways."
+ },
+ "egressGateways": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 0,
+ "description": "Istio egress gateways."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioIngressGateway",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/272"
+ },
+ "flags": 1,
+ "description": "Mode of an ingress gateway."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable the ingress gateway."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/269"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioEgressGateway",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable the egress gateway."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/274"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioCertificateAuthority",
+ "properties": {
+ "plugin": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 0,
+ "description": "Plugin certificates information for Service Mesh."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioPluginCertificateAuthority",
+ "properties": {
+ "keyVaultId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the Key Vault."
+ },
+ "certObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate object name in Azure Key Vault."
+ },
+ "keyObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate private key object name in Azure Key Vault."
+ },
+ "rootCertObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Root certificate object name in Azure Key Vault."
+ },
+ "certChainObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Certificate chain object name in Azure Key Vault."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterMetricsProfile",
+ "properties": {
+ "costAnalysis": {
+ "type": {
+ "$ref": "#/280"
+ },
+ "flags": 0,
+ "description": "The cost analysis configuration for the cluster"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterCostAnalysis",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterBootstrapProfile",
+ "properties": {
+ "artifactSource": {
+ "type": {
+ "$ref": "#/284"
+ },
+ "flags": 0,
+ "description": "The source where the artifacts are downloaded from."
+ },
+ "containerRegistryId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cache"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Direct"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/282"
+ },
+ {
+ "$ref": "#/283"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/296"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/287"
+ },
+ {
+ "$ref": "#/288"
+ },
+ {
+ "$ref": "#/289"
+ },
+ {
+ "$ref": "#/290"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/292"
+ },
+ {
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/301"
+ },
+ "flags": 0,
+ "description": "Properties of a default maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceConfigurationProperties",
+ "properties": {
+ "timeInWeek": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries."
+ },
+ "notAllowedTime": {
+ "type": {
+ "$ref": "#/315"
+ },
+ "flags": 0,
+ "description": "Time slots on which upgrade is not allowed."
+ },
+ "maintenanceWindow": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 0,
+ "description": "Maintenance window for the maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeInWeek",
+ "properties": {
+ "day": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "The day of the week."
+ },
+ "hourSlots": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 0,
+ "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/303"
+ },
+ {
+ "$ref": "#/304"
+ },
+ {
+ "$ref": "#/305"
+ },
+ {
+ "$ref": "#/306"
+ },
+ {
+ "$ref": "#/307"
+ },
+ {
+ "$ref": "#/308"
+ },
+ {
+ "$ref": "#/309"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 23
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/311"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/302"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The start of a time span"
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end of a time span"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/314"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceWindow",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 1,
+ "description": "Recurrence schedule for the maintenance window."
+ },
+ "durationHours": {
+ "type": {
+ "$ref": "#/348"
+ },
+ "flags": 1,
+ "description": "Length of maintenance window range from 4 to 24 hours."
+ },
+ "utcOffset": {
+ "type": {
+ "$ref": "#/349"
+ },
+ "flags": 0,
+ "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/350"
+ },
+ "flags": 1,
+ "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'."
+ },
+ "notAllowedDates": {
+ "type": {
+ "$ref": "#/352"
+ },
+ "flags": 0,
+ "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Schedule",
+ "properties": {
+ "daily": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every day' or 'recur every 3 days'."
+ },
+ "weekly": {
+ "type": {
+ "$ref": "#/320"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'."
+ },
+ "absoluteMonthly": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'."
+ },
+ "relativeMonthly": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DailySchedule",
+ "properties": {
+ "intervalDays": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 1,
+ "description": "Specifies the number of days between each set of occurrences."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 7
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WeeklySchedule",
+ "properties": {
+ "intervalWeeks": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 1,
+ "description": "Specifies the number of weeks between each set of occurrences."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 4
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/322"
+ },
+ {
+ "$ref": "#/323"
+ },
+ {
+ "$ref": "#/324"
+ },
+ {
+ "$ref": "#/325"
+ },
+ {
+ "$ref": "#/326"
+ },
+ {
+ "$ref": "#/327"
+ },
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AbsoluteMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "dayOfMonth": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 1,
+ "description": "The date of the month."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 6
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 31
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RelativeMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "weekIndex": {
+ "type": {
+ "$ref": "#/339"
+ },
+ "flags": 1,
+ "description": "Specifies on which week of the month the dayOfWeek applies."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/335"
+ },
+ {
+ "$ref": "#/336"
+ },
+ {
+ "$ref": "#/337"
+ },
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/343"
+ },
+ {
+ "$ref": "#/344"
+ },
+ {
+ "$ref": "#/345"
+ },
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 24
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^\\d{2}:\\d{2}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DateSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date of the date span."
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date of the date span."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/351"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/300"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 12,
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/354"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/355"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/358"
+ },
+ "flags": 0,
+ "description": "Properties of an agent pool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfileProperties",
+ "properties": {
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/379"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/382"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/385"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/386"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/389"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/392"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/393"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/394"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 0,
+ "description": "GPU settings for the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/359"
+ },
+ {
+ "$ref": "#/360"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/362"
+ },
+ {
+ "$ref": "#/363"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/366"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/371"
+ },
+ {
+ "$ref": "#/372"
+ },
+ {
+ "$ref": "#/373"
+ },
+ {
+ "$ref": "#/374"
+ },
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/377"
+ },
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/384"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/387"
+ },
+ {
+ "$ref": "#/388"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/390"
+ },
+ {
+ "$ref": "#/391"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/396"
+ },
+ {
+ "$ref": "#/397"
+ },
+ {
+ "$ref": "#/398"
+ },
+ {
+ "$ref": "#/399"
+ },
+ {
+ "$ref": "#/400"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/357"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/403"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/406"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/413"
+ },
+ "flags": 0,
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/414"
+ },
+ "flags": 1,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/407"
+ },
+ {
+ "$ref": "#/408"
+ },
+ {
+ "$ref": "#/409"
+ },
+ {
+ "$ref": "#/410"
+ },
+ {
+ "$ref": "#/411"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the private endpoint"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The private link service connection description."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/415"
+ },
+ {
+ "$ref": "#/416"
+ },
+ {
+ "$ref": "#/417"
+ },
+ {
+ "$ref": "#/418"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/405"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/snapshots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/snapshots",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/421"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/422"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/424"
+ },
+ "flags": 0,
+ "description": "Properties of a snapshot."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SnapshotProperties",
+ "properties": {
+ "creationData": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "type": {
+ "$ref": "#/426"
+ },
+ "flags": 0,
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of Kubernetes."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/429"
+ },
+ "flags": 2,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSku": {
+ "type": {
+ "$ref": "#/435"
+ },
+ "flags": 2,
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The size of the VM."
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 2,
+ "description": "Whether to use a FIPS-enabled OS."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodePool"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/425"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/427"
+ },
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/430"
+ },
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/snapshots@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/423"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^([A-Za-z0-9-])+$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/438"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/439"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/442"
+ },
+ "flags": 1,
+ "description": "Properties for trusted access role binding"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrustedAccessRoleBindingProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/448"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of trusted access role binding."
+ },
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ARM resource ID of source resource that trusted access is configured for."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/449"
+ },
+ "flags": 1,
+ "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/443"
+ },
+ {
+ "$ref": "#/444"
+ },
+ {
+ "$ref": "#/445"
+ },
+ {
+ "$ref": "#/446"
+ },
+ {
+ "$ref": "#/447"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/441"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/meshRevisionProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/451"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/452"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/453"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 2,
+ "description": "Mesh revision profile properties for a mesh"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevisionProfileProperties",
+ "properties": {
+ "meshRevisions": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevision",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/460"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CompatibleVersions",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The product/service name."
+ },
+ "versions": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 0,
+ "description": "Product/service versions compatible with a service mesh add-on revision."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/458"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/456"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles@2025-01-01",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/454"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/451"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/464"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/466"
+ },
+ "flags": 2,
+ "description": "Mesh upgrade profile properties for a major.minor release."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshUpgradeProfileProperties",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/467"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/468"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/458"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/465"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools/machines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/470"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/471"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/472"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/474"
+ },
+ "flags": 2,
+ "description": "The properties of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineProperties",
+ "properties": {
+ "network": {
+ "type": {
+ "$ref": "#/475"
+ },
+ "flags": 2,
+ "description": "network properties of the machine"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Azure resource id of the machine. It can be used to GET underlying VM Instance"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineNetworkProperties",
+ "properties": {
+ "ipAddresses": {
+ "type": {
+ "$ref": "#/480"
+ },
+ "flags": 2,
+ "description": "IPv4, IPv6 addresses of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineIpAddress",
+ "properties": {
+ "family": {
+ "type": {
+ "$ref": "#/479"
+ },
+ "flags": 2,
+ "description": "To determine if address belongs IPv4 or IPv6 family"
+ },
+ "ip": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "IPv4 or IPv6 address of the machine"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/477"
+ },
+ {
+ "$ref": "#/478"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/476"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines@2025-01-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/473"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAccessProfile",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/483"
+ },
+ "flags": 0,
+ "description": "AccessProfile of a managed cluster."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/484"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessProfile",
+ "properties": {
+ "kubeConfig": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 0,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters/accessProfiles",
+ "apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/482"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResults",
+ "properties": {
+ "kubeconfigs": {
+ "type": {
+ "$ref": "#/488"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResult",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/487"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterAdminCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/486"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/486"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterMonitoringUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/486"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetServicePrincipalProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "input": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetAADProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "input": {
+ "$ref": "#/205"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateClusterCertificates",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters",
+ "apiVersion": "2025-01-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateServiceAccountSigningKeys",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stop",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandRequest",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The command to run."
+ },
+ "context": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64 encoded zip file containing the files required by the command."
+ },
+ "clusterToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AuthToken issued for AKS AAD Server App."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command id."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/501"
+ },
+ "flags": 0,
+ "description": "Properties of command result."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandResultProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "provisioning State"
+ },
+ "exitCode": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 2,
+ "description": "The exit code of the command"
+ },
+ "startedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command started."
+ },
+ "finishedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command finished."
+ },
+ "logs": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command output."
+ },
+ "reason": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "An explanation of why provisioningState is set to failed (if so)."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "runCommand",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/500"
+ },
+ "input": {
+ "$ref": "#/499"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resolvePrivateLinkServiceId",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/230"
+ },
+ "input": {
+ "$ref": "#/230"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters/agentPools",
+ "apiVersion": "2025-01-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolDeleteMachinesParameter",
+ "properties": {
+ "machineNames": {
+ "type": {
+ "$ref": "#/506"
+ },
+ "flags": 1,
+ "description": "The agent pool machine names."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deleteMachines",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-01-01",
+ "input": {
+ "$ref": "#/505"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "upgradeNodeImageVersion",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-01-01"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/containerservice/microsoft.containerservice/2025-01-02-preview/types.json b/internal/azure/generated/containerservice/microsoft.containerservice/2025-01-02-preview/types.json
new file mode 100644
index 000000000..0a12357d7
--- /dev/null
+++ b/internal/azure/generated/containerservice/microsoft.containerservice/2025-01-02-preview/types.json
@@ -0,0 +1,9419 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The managed cluster SKU."
+ },
+ "extendedLocation": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 0,
+ "description": "The extended location of the Virtual Machine."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "The identity of the managed cluster, if configured."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "Properties of a managed cluster."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is primarily used to expose different UI experiences in the portal for different kinds"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSKU",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The name of a managed cluster SKU."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Base"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Automatic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Free"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExtendedLocation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EdgeZone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of the system assigned identity which is used by master components."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant id of the system assigned identity which is used by master components."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/20"
+ },
+ "flags": 0,
+ "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity)."
+ },
+ "delegatedResources": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 0,
+ "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResource",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ARM resource id of the delegated resource - internal use only."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "The tenant id of the delegated resource - internal use only."
+ },
+ "referralResource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The delegation id of the referral delegation (optional) - internal use only."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source resource location - internal use only."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResources",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/21"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/24"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "The Power State of the cluster."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot."
+ },
+ "maxAgentPools": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 2,
+ "description": "The max number of agent pools for the managed cluster."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details."
+ },
+ "currentKubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of Kubernetes the Managed Cluster is running."
+ },
+ "dnsPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdnSubdomain": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of the master pool."
+ },
+ "privateFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of private cluster."
+ },
+ "azurePortalFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly."
+ },
+ "agentPoolProfiles": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The agent pool properties."
+ },
+ "linuxProfile": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The profile for Linux VMs in the Managed Cluster."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 0,
+ "description": "The profile for Windows VMs in the Managed Cluster."
+ },
+ "servicePrincipalProfile": {
+ "type": {
+ "$ref": "#/158"
+ },
+ "flags": 0,
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs."
+ },
+ "addonProfiles": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "The profile of managed cluster add-on."
+ },
+ "podIdentityProfile": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration."
+ },
+ "oidcIssuerProfile": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 0,
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "nodeResourceGroup": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the resource group containing agent pool nodes."
+ },
+ "nodeResourceGroupProfile": {
+ "type": {
+ "$ref": "#/182"
+ },
+ "flags": 0,
+ "description": "The node resource group configuration profile."
+ },
+ "enableRBAC": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Kubernetes Role-Based Access Control."
+ },
+ "supportPlan": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'."
+ },
+ "enablePodSecurityPolicy": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp."
+ },
+ "enableNamespaceResources": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 0,
+ "description": "The network configuration profile."
+ },
+ "aadProfile": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "The Azure Active Directory configuration."
+ },
+ "autoUpgradeProfile": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 0,
+ "description": "The auto upgrade configuration."
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading a cluster."
+ },
+ "autoScalerProfile": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 0,
+ "description": "Parameters to be applied to the cluster-autoscaler when enabled"
+ },
+ "apiServerAccessProfile": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 0,
+ "description": "The access profile for managed cluster API server."
+ },
+ "diskEncryptionSetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'"
+ },
+ "identityProfile": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 0,
+ "description": "The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is \"kubeletidentity\", with value of \"resourceId\": \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}\"."
+ },
+ "privateLinkResources": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 0,
+ "description": "Private link resources associated with the cluster."
+ },
+ "disableLocalAccounts": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)."
+ },
+ "httpProxyConfig": {
+ "type": {
+ "$ref": "#/289"
+ },
+ "flags": 0,
+ "description": "Configurations for provisioning the cluster with HTTP proxy servers."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 0,
+ "description": "Security profile for the managed cluster."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 0,
+ "description": "Storage profile for the managed cluster."
+ },
+ "ingressProfile": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "Ingress profile for the managed cluster."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 0,
+ "description": "Allow or deny public network access for AKS"
+ },
+ "workloadAutoScalerProfile": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 0,
+ "description": "Workload Auto-scaler profile for the managed cluster."
+ },
+ "azureMonitorProfile": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 0,
+ "description": "Prometheus addon profile for the container service cluster"
+ },
+ "safeguardsProfile": {
+ "type": {
+ "$ref": "#/340"
+ },
+ "flags": 0,
+ "description": "The Safeguards profile holds all the safeguards information for a given cluster"
+ },
+ "serviceMeshProfile": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 0,
+ "description": "Service mesh profile for a managed cluster."
+ },
+ "resourceUID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)"
+ },
+ "metricsProfile": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 0,
+ "description": "Optional cluster metrics configuration."
+ },
+ "aiToolchainOperatorProfile": {
+ "type": {
+ "$ref": "#/366"
+ },
+ "flags": 0,
+ "description": "AI toolchain operator settings that apply to the whole cluster."
+ },
+ "nodeProvisioningProfile": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 0,
+ "description": "Node provisioning settings that apply to the whole cluster."
+ },
+ "bootstrapProfile": {
+ "type": {
+ "$ref": "#/371"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster bootstrap configuration."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/375"
+ },
+ "flags": 0,
+ "description": "Contains read-only information about the Managed Cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PowerState",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Tells whether the cluster is Running or Stopped"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/29"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreationData",
+ "properties": {
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is the ARM ID of the source object to be used to create the target object."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfile",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 1,
+ "description": "Windows agent pool names must be 6 characters or less."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/38"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/41"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podIPAllocationMode": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'."
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/67"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "enableCustomCATrust": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/84"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "nodeInitializationTaints": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`"
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The GPU settings of an agent pool."
+ },
+ "artifactStreamingProfile": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "Configuration for using artifact streaming on AKS."
+ },
+ "virtualMachinesProfile": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Specifications on VirtualMachines agent pool."
+ },
+ "virtualMachineNodesStatus": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "The status of nodes in a VirtualMachines agent pool."
+ },
+ "gatewayProfile": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 0,
+ "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "Contains read-only information about the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 2048
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KataMshvVmIsolation"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DynamicIndividual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StaticBlock"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/52"
+ },
+ {
+ "$ref": "#/53"
+ },
+ {
+ "$ref": "#/54"
+ },
+ {
+ "$ref": "#/55"
+ },
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachines"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Gateway"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolUpgradeSettings",
+ "properties": {
+ "maxSurge": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster"
+ },
+ "maxUnavailable": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster"
+ },
+ "maxBlockedNodes": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is maxSurge. This must always be greater than or equal to maxSurge. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster"
+ },
+ "drainTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes."
+ },
+ "nodeSoakDurationInMinutes": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes."
+ },
+ "undrainableNodeBehavior": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 1440
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 30
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cordon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Schedule"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubeletConfig",
+ "properties": {
+ "cpuManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'."
+ },
+ "cpuCfsQuota": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "cpuCfsQuotaPeriod": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'."
+ },
+ "imageGcHighThreshold": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "To disable image garbage collection, set to 100. The default is 85%"
+ },
+ "imageGcLowThreshold": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%"
+ },
+ "topologyManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'."
+ },
+ "allowedUnsafeSysctls": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)."
+ },
+ "failSwapOn": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node."
+ },
+ "containerLogMaxSizeMB": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated."
+ },
+ "containerLogMaxFiles": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 0,
+ "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2."
+ },
+ "podMaxPids": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of processes per pod."
+ },
+ "seccompDefault": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "Specifies the default seccomp profile applied to all workloads. If not specified, 'Unconfined' will be used by default."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 2
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unconfined"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RuntimeDefault"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/92"
+ },
+ {
+ "$ref": "#/93"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxOSConfig",
+ "properties": {
+ "sysctls": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 0,
+ "description": "Sysctl settings for Linux agent nodes."
+ },
+ "transparentHugePageEnabled": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "transparentHugePageDefrag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "swapFileSizeMB": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The size in MB of a swap file that will be created on each node."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SysctlConfig",
+ "properties": {
+ "netCoreSomaxconn": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.somaxconn."
+ },
+ "netCoreNetdevMaxBacklog": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.netdev_max_backlog."
+ },
+ "netCoreRmemDefault": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_default."
+ },
+ "netCoreRmemMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_max."
+ },
+ "netCoreWmemDefault": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_default."
+ },
+ "netCoreWmemMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_max."
+ },
+ "netCoreOptmemMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.optmem_max."
+ },
+ "netIpv4TcpMaxSynBacklog": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog."
+ },
+ "netIpv4TcpMaxTwBuckets": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets."
+ },
+ "netIpv4TcpFinTimeout": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_fin_timeout."
+ },
+ "netIpv4TcpKeepaliveTime": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_time."
+ },
+ "netIpv4TcpKeepaliveProbes": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_probes."
+ },
+ "netIpv4TcpkeepaliveIntvl": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl."
+ },
+ "netIpv4TcpTwReuse": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_tw_reuse."
+ },
+ "netIpv4IpLocalPortRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.ip_local_port_range."
+ },
+ "netIpv4NeighDefaultGcThresh1": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1."
+ },
+ "netIpv4NeighDefaultGcThresh2": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2."
+ },
+ "netIpv4NeighDefaultGcThresh3": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3."
+ },
+ "netNetfilterNfConntrackMax": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_max."
+ },
+ "netNetfilterNfConntrackBuckets": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_buckets."
+ },
+ "fsInotifyMaxUserWatches": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.inotify.max_user_watches."
+ },
+ "fsFileMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.file-max."
+ },
+ "fsAioMaxNr": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.aio-max-nr."
+ },
+ "fsNrOpen": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.nr_open."
+ },
+ "kernelThreadsMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting kernel.threads-max."
+ },
+ "vmMaxMapCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.max_map_count."
+ },
+ "vmSwappiness": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.swappiness."
+ },
+ "vmVfsCachePressure": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.vfs_cache_pressure."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 10,
+ "maxValue": 90
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 131072,
+ "maxValue": 2097152
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 65536,
+ "maxValue": 524288
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolWindowsProfile",
+ "properties": {
+ "disableOutboundNat": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolNetworkProfile",
+ "properties": {
+ "nodePublicIPTags": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "IPTags of instance-level public IPs."
+ },
+ "allowedHostPorts": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap."
+ },
+ "applicationSecurityGroups": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "The IDs of the application security groups which agent pool will associate when created."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IPTag",
+ "properties": {
+ "ipTagType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP tag type. Example: RoutingPreference."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The value of the IP tag associated with the public IP. Example: Internet."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/108"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PortRange",
+ "properties": {
+ "portStart": {
+ "type": {
+ "$ref": "#/111"
+ },
+ "flags": 0,
+ "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd."
+ },
+ "portEnd": {
+ "type": {
+ "$ref": "#/111"
+ },
+ "flags": 0,
+ "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart."
+ },
+ "protocol": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "The network protocol of the port."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 65535
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TCP"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UDP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/110"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolSecurityProfile",
+ "properties": {
+ "sshAccess": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 0,
+ "description": "SSH access method of an agent pool."
+ },
+ "enableVTPM": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ },
+ "enableSecureBoot": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LocalUser"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolGPUProfile",
+ "properties": {
+ "installGPUDriver": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves."
+ },
+ "driverType": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "Specify the type of GPU driver to install when creating Windows agent pools. If not provided, AKS selects the driver based on system compatibility. This cannot be changed once the AgentPool has been created. This cannot be set on Linux AgentPools. For Linux AgentPools, the driver is selected based on system compatibility."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GRID"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CUDA"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolArtifactStreamingProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachinesProfile",
+ "properties": {
+ "scale": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 0,
+ "description": "Specifications on how to scale a VirtualMachines agent pool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScaleProfile",
+ "properties": {
+ "manual": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 0,
+ "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size."
+ },
+ "autoscale": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 0,
+ "description": "Specifications on how to auto-scale the VirtualMachines agent pool within a predefined size range. Currently, at most one AutoScaleProfile is allowed."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManualScaleProfile",
+ "properties": {
+ "sizes": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 0,
+ "description": "The list of allowed vm sizes e.g. ['Standard_E4s_v3', 'Standard_E16s_v3', 'Standard_D16s_v5']. AKS will use the first available one when scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of nodes."
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/128"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoScaleProfile",
+ "properties": {
+ "sizes": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "The list of allowed vm sizes e.g. ['Standard_E4s_v3', 'Standard_E16s_v3', 'Standard_D16s_v5']. AKS will use the first available one when auto scaling. If a VM size is unavailable (e.g. due to quota or regional capacity reasons), AKS will use the next size."
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes of the specified sizes."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes of the specified sizes."
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/137"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/134"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNodes",
+ "properties": {
+ "size": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The VM size of the agents used to host this group of nodes."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of nodes."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/140"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolGatewayProfile",
+ "properties": {
+ "publicIPPrefixSize": {
+ "type": {
+ "$ref": "#/143"
+ },
+ "flags": 0,
+ "description": "The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 28,
+ "maxValue": 31
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolStatus",
+ "properties": {
+ "provisioningError": {
+ "type": {
+ "$ref": "#/145"
+ },
+ "flags": 2,
+ "description": "Preserves the detailed info of failure. If there was no error, this field is omitted."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CloudErrorBody",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 0,
+ "description": "A list of additional details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/145"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/33"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceLinuxProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 1,
+ "description": "The administrator username to use for Linux VMs."
+ },
+ "ssh": {
+ "type": {
+ "$ref": "#/150"
+ },
+ "flags": 1,
+ "description": "The SSH configuration for Linux-based VMs running on Azure."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshConfiguration",
+ "properties": {
+ "publicKeys": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 1,
+ "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshPublicKey",
+ "properties": {
+ "keyData": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/151"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWindowsProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Specifies the name of the administrator account.
**Max-length:** 20 characters"
+ },
+ "adminPassword": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length:** 8 characters
**Max-length:** 123 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\""
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 0,
+ "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details."
+ },
+ "enableCSIProxy": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)."
+ },
+ "gmsaProfile": {
+ "type": {
+ "$ref": "#/157"
+ },
+ "flags": 0,
+ "description": "The Windows gMSA Profile in the Managed Cluster."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows_Server"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/154"
+ },
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsGmsaProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Specifies whether to enable Windows gMSA in the managed cluster."
+ },
+ "dnsServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the DNS server for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ },
+ "rootDomainName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the root domain name for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterServicePrincipalProfile",
+ "properties": {
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ID for the service principal."
+ },
+ "secret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The secret password associated with the service principal in plain text."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether the add-on is enabled or not."
+ },
+ "config": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 0,
+ "description": "Key-value pairs for configuring an add-on."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/161"
+ },
+ "flags": 2,
+ "description": "Information of user assigned identity used by this add-on."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileConfig",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAddonProfiles",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/159"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether the pod identity addon is enabled."
+ },
+ "allowNetworkPluginKubenet": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/177"
+ },
+ "flags": 0,
+ "description": "The pod identities to use in the cluster."
+ },
+ "userAssignedIdentityExceptions": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "The pod identity exceptions to allow."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentity",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity."
+ },
+ "bindingSelector": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The binding selector to use for the AzureIdentityBinding resource."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 1,
+ "description": "The user assigned identity details."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of the pod identity."
+ },
+ "provisioningInfo": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Assigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/169"
+ },
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningInfo",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 0,
+ "description": "Pod identity assignment error (if any)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 0,
+ "description": "Details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningErrorBody",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "A list of additional details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/175"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/164"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityException",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity exception."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity exception."
+ },
+ "podLabels": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 1,
+ "description": "The pod labels to match."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityExceptionPodLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/178"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterOidcIssuerProfile",
+ "properties": {
+ "issuerURL": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The OIDC issuer url of the Managed Cluster."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether the OIDC issuer is enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNodeResourceGroupProfile",
+ "properties": {
+ "restrictionLevel": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 0,
+ "description": "The restriction level applied to the cluster's node resource group"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unrestricted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/184"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesOfficial"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AKSLongTermSupport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/186"
+ },
+ {
+ "$ref": "#/187"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfile",
+ "properties": {
+ "networkPlugin": {
+ "type": {
+ "$ref": "#/193"
+ },
+ "flags": 0,
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "networkPluginMode": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Network plugin mode used for building the Kubernetes network."
+ },
+ "networkPolicy": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "networkMode": {
+ "type": {
+ "$ref": "#/203"
+ },
+ "flags": 0,
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "networkDataplane": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "Network dataplane used in the Kubernetes cluster."
+ },
+ "podCidr": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used."
+ },
+ "serviceCidr": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges."
+ },
+ "dnsServiceIP": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr."
+ },
+ "outboundType": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)."
+ },
+ "loadBalancerSku": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "loadBalancerProfile": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster load balancer."
+ },
+ "natGatewayProfile": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster NAT gateway."
+ },
+ "staticEgressGatewayProfile": {
+ "type": {
+ "$ref": "#/240"
+ },
+ "flags": 0,
+ "description": "The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway."
+ },
+ "podCidrs": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking."
+ },
+ "serviceCidrs": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges."
+ },
+ "ipFamilies": {
+ "type": {
+ "$ref": "#/246"
+ },
+ "flags": 0,
+ "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6."
+ },
+ "podLinkLocalAccess": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'."
+ },
+ "kubeProxyConfig": {
+ "type": {
+ "$ref": "#/250"
+ },
+ "flags": 0,
+ "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'."
+ },
+ "advancedNetworking": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 0,
+ "description": "Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "kubenet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/190"
+ },
+ {
+ "$ref": "#/191"
+ },
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "overlay"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/194"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "calico"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/196"
+ },
+ {
+ "$ref": "#/197"
+ },
+ {
+ "$ref": "#/198"
+ },
+ {
+ "$ref": "#/199"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "transparent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "bridge"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/201"
+ },
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "loadBalancer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userDefinedRouting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "managedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userAssignedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/211"
+ },
+ {
+ "$ref": "#/212"
+ },
+ {
+ "$ref": "#/213"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/215"
+ },
+ {
+ "$ref": "#/216"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfile",
+ "properties": {
+ "managedOutboundIPs": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 0,
+ "description": "Desired managed outbound IPs for the cluster load balancer."
+ },
+ "outboundIPPrefixes": {
+ "type": {
+ "$ref": "#/222"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP Prefix resources for the cluster load balancer."
+ },
+ "outboundIPs": {
+ "type": {
+ "$ref": "#/225"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP resources for the cluster load balancer."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster load balancer."
+ },
+ "allocatedOutboundPorts": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes."
+ },
+ "enableMultipleStandardLoadBalancers": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Enable multiple standard load balancers per AKS cluster or not."
+ },
+ "backendPoolType": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 0,
+ "description": "The type of the managed inbound Load Balancer BackendPool."
+ },
+ "clusterServiceLoadBalancerHealthProbeMode": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "The health probing behavior for External Traffic Policy Cluster services."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileManagedOutboundIPs",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1."
+ },
+ "countIPv6": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 100
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 100
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPPrefixes",
+ "properties": {
+ "publicIPPrefixes": {
+ "type": {
+ "$ref": "#/224"
+ },
+ "flags": 0,
+ "description": "A list of public IP prefix resources."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The fully qualified Azure resource id."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPs",
+ "properties": {
+ "publicIPs": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "A list of public IP resources."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 64000
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 120
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIPConfiguration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/230"
+ },
+ {
+ "$ref": "#/231"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ServiceNodePort"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Shared"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/233"
+ },
+ {
+ "$ref": "#/234"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNATGatewayProfile",
+ "properties": {
+ "managedOutboundIPProfile": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "Profile of the managed outbound IP resources of the cluster NAT gateway."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster NAT gateway."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterManagedOutboundIPProfile",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 0,
+ "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 16
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStaticEgressGatewayProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Static Egress Gateway addon is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/243"
+ },
+ {
+ "$ref": "#/244"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/245"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IMDS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/248"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfileKubeProxyConfig",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "Specify which proxy mode to use ('IPTABLES' or 'IPVS')"
+ },
+ "ipvsConfig": {
+ "type": {
+ "$ref": "#/254"
+ },
+ "flags": 0,
+ "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPTABLES"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPVS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/252"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfileKubeProxyConfigIpvsConfig",
+ "properties": {
+ "scheduler": {
+ "type": {
+ "$ref": "#/257"
+ },
+ "flags": 0,
+ "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html."
+ },
+ "tcpTimeoutSeconds": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value."
+ },
+ "tcpFinTimeoutSeconds": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value."
+ },
+ "udpTimeoutSeconds": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RoundRobin"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LeastConnection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworking",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false."
+ },
+ "observability": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts."
+ },
+ "security": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 0,
+ "description": "Security profile to enable security features on cilium based cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingObservability",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingSecurity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAADProfile",
+ "properties": {
+ "managed": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable managed AAD."
+ },
+ "enableAzureRBAC": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure RBAC for Kubernetes authorization."
+ },
+ "adminGroupObjectIDs": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 0,
+ "description": "The list of AAD group object IDs that will have admin role of the cluster."
+ },
+ "clientAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppSecret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "tenantID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAutoUpgradeProfile",
+ "properties": {
+ "upgradeChannel": {
+ "type": {
+ "$ref": "#/269"
+ },
+ "flags": 0,
+ "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)."
+ },
+ "nodeOSUpgradeChannel": {
+ "type": {
+ "$ref": "#/274"
+ },
+ "flags": 0,
+ "description": "The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "rapid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "stable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "patch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "node-image"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/264"
+ },
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/267"
+ },
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unmanaged"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecurityPatch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeImage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/272"
+ },
+ {
+ "$ref": "#/273"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterUpgradeSettings",
+ "properties": {
+ "overrideSettings": {
+ "type": {
+ "$ref": "#/276"
+ },
+ "flags": 0,
+ "description": "Settings for overrides."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpgradeOverrideSettings",
+ "properties": {
+ "forceUpgrade": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution."
+ },
+ "until": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAutoScalerProfile",
+ "properties": {
+ "balance-similar-node-groups": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'true' and 'false'"
+ },
+ "daemonset-eviction-for-empty-nodes": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "daemonset-eviction-for-occupied-nodes": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "ignore-daemonsets-utilization": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions."
+ },
+ "expander": {
+ "type": {
+ "$ref": "#/282"
+ },
+ "flags": 0,
+ "description": "Available values are: 'least-waste', 'most-pods', 'priority', 'random'."
+ },
+ "max-empty-bulk-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 10."
+ },
+ "max-graceful-termination-sec": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 600."
+ },
+ "max-node-provision-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "max-total-unready-percentage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 45. The maximum is 100 and the minimum is 0."
+ },
+ "new-pod-scale-up-delay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)."
+ },
+ "ok-total-unready-count": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This must be an integer. The default is 3."
+ },
+ "scan-interval": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10'. Values must be an integer number of seconds."
+ },
+ "scale-down-delay-after-add": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-failure": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unneeded-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unready-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-utilization-threshold": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '0.5'."
+ },
+ "skip-nodes-with-local-storage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "skip-nodes-with-system-pods": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "least-waste"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "most-pods"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "priority"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "random"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/281"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAPIServerAccessProfile",
+ "properties": {
+ "authorizedIPRanges": {
+ "type": {
+ "$ref": "#/284"
+ },
+ "flags": 0,
+ "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)."
+ },
+ "enablePrivateCluster": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)."
+ },
+ "privateDNSZone": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'."
+ },
+ "enablePrivateClusterPublicFQDN": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to create additional public FQDN for private cluster or not."
+ },
+ "disableRunCommand": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to disable run command for the cluster or not."
+ },
+ "enableVnetIntegration": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable apiserver vnet integration for the cluster or not."
+ },
+ "subnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesIdentityProfile",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/165"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the private link resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the private link resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource type."
+ },
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The group ID of the resource."
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 0,
+ "description": "The RequiredMembers of the resource"
+ },
+ "privateLinkServiceID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The private link service ID of the resource, this field is exposed only to NRP internally."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/286"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterHttpProxyConfig",
+ "properties": {
+ "httpProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP proxy server endpoint to use."
+ },
+ "httpsProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTPS proxy server endpoint to use."
+ },
+ "noProxy": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 0,
+ "description": "The endpoints that should not go through proxy."
+ },
+ "effectiveNoProxy": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 2,
+ "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS."
+ },
+ "trustedCa": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Alternative CA cert to use for connecting to proxy servers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfile",
+ "properties": {
+ "defender": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "azureKeyVaultKms": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 0,
+ "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile."
+ },
+ "workloadIdentity": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 0,
+ "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details."
+ },
+ "imageCleaner": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 0,
+ "description": "Image Cleaner settings for the security profile."
+ },
+ "imageIntegrity": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 0,
+ "description": "Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy."
+ },
+ "nodeRestriction": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 0,
+ "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile."
+ },
+ "customCATrustCertificates": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefender",
+ "properties": {
+ "logAnalyticsWorkspaceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty."
+ },
+ "securityMonitoring": {
+ "type": {
+ "$ref": "#/294"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender threat detection for Cloud settings for the security profile."
+ },
+ "securityGating": {
+ "type": {
+ "$ref": "#/295"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender settings for security gating, validates container images eligibility for deployment based on Defender for Containers security findings. Using Admission Controller, it either audits or prevents the deployment of images that do not meet security standards."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityMonitoring",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Defender threat detection"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityGating",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Defender security gating. When enabled, the gating feature will scan container images and audit or block the deployment of images that do not meet security standards according to the configured security rules."
+ },
+ "identities": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 0,
+ "description": "List of identities that the admission controller will make use of in order to pull security artifacts from the registry. These are the same identities used by the cluster to pull container images. Each identity provided should have federated identity credential attached to it."
+ },
+ "allowSecretAccess": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "In use only while registry access granted by secret rather than managed identity. Set whether to grant the Defender gating agent access to the cluster's secrets for pulling images from registries. If secret access is denied and the registry requires pull secrets, the add-on will not perform any image validation. Default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityGatingIdentitiesItem",
+ "properties": {
+ "azureContainerRegistry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The container registry for which the identity will be used; the identity specified here should have a federated identity credential attached to it."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "The identity object used to access the registry"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/296"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureKeyVaultKms",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure Key Vault key management service. The default is false."
+ },
+ "keyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
+ },
+ "keyVaultNetworkAccess": {
+ "type": {
+ "$ref": "#/301"
+ },
+ "flags": 0,
+ "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`."
+ },
+ "keyVaultResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Public"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Private"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/299"
+ },
+ {
+ "$ref": "#/300"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileWorkloadIdentity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable workload identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileImageCleaner",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Image Cleaner on AKS cluster."
+ },
+ "intervalHours": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Image Cleaner scanning interval in hours."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileImageIntegrity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable image integrity. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileNodeRestriction",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Node Restriction"
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/306"
+ },
+ "maxLength": 10
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfile",
+ "properties": {
+ "diskCSIDriver": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "fileCSIDriver": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "snapshotController": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 0,
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "blobCSIDriver": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 0,
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileDiskCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureDisk CSI Driver. The default value is true."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of AzureDisk CSI Driver. The default value is v1."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileFileCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureFile CSI Driver. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileSnapshotController",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Snapshot Controller. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileBlobCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureBlob CSI Driver. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfile",
+ "properties": {
+ "webAppRouting": {
+ "type": {
+ "$ref": "#/314"
+ },
+ "flags": 0,
+ "description": "Web App Routing settings for the ingress profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileWebAppRouting",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Web App Routing."
+ },
+ "dnsZoneResourceIds": {
+ "type": {
+ "$ref": "#/315"
+ },
+ "flags": 0,
+ "description": "Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group."
+ },
+ "nginx": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 0,
+ "description": "Configuration for the default NginxIngressController. See more at https://learn.microsoft.com/en-us/azure/aks/app-routing-nginx-configuration#the-default-nginx-ingress-controller."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 2,
+ "description": "Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 5
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileNginx",
+ "properties": {
+ "defaultIngressControllerType": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 0,
+ "description": "Ingress type for the default NginxIngressController custom resource"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AnnotationControlled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/317"
+ },
+ {
+ "$ref": "#/318"
+ },
+ {
+ "$ref": "#/319"
+ },
+ {
+ "$ref": "#/320"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecuredByPerimeter"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/322"
+ },
+ {
+ "$ref": "#/323"
+ },
+ {
+ "$ref": "#/324"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfile",
+ "properties": {
+ "keda": {
+ "type": {
+ "$ref": "#/327"
+ },
+ "flags": 0,
+ "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile."
+ },
+ "verticalPodAutoscaler": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileKeda",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable KEDA."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable VPA add-on in cluster. Default value is false."
+ },
+ "addonAutoscaling": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 0,
+ "description": "Whether VPA add-on is enabled and configured to scale AKS-managed add-ons."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/329"
+ },
+ {
+ "$ref": "#/330"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfile",
+ "properties": {
+ "metrics": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Metrics profile for the prometheus service addon"
+ },
+ "containerInsights": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 0,
+ "description": "Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview."
+ },
+ "appMonitoring": {
+ "type": {
+ "$ref": "#/336"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileMetrics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable the Prometheus collector"
+ },
+ "kubeStateMetrics": {
+ "type": {
+ "$ref": "#/334"
+ },
+ "flags": 0,
+ "description": "Kube State Metrics for prometheus addon profile for the container service cluster"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileKubeStateMetrics",
+ "properties": {
+ "metricLabelsAllowlist": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of Kubernetes annotations keys that will be used in the resource's labels metric."
+ },
+ "metricAnnotationsAllowList": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileContainerInsights",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Azure Monitor Container Insights Logs Addon is enabled or not."
+ },
+ "logAnalyticsWorkspaceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs."
+ },
+ "syslogPort": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The syslog host port. If not specified, the default port is 28330."
+ },
+ "disableCustomMetrics": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false"
+ },
+ "disablePrometheusMetricsScraping": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoring",
+ "properties": {
+ "autoInstrumentation": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ },
+ "openTelemetryMetrics": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ },
+ "openTelemetryLogs": {
+ "type": {
+ "$ref": "#/339"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Application Monitoring Auto Instrumentation is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Application Monitoring Open Telemetry Metrics is enabled or not."
+ },
+ "port": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not."
+ },
+ "port": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SafeguardsProfile",
+ "properties": {
+ "systemExcludedNamespaces": {
+ "type": {
+ "$ref": "#/341"
+ },
+ "flags": 2,
+ "description": "List of namespaces specified by AKS to be excluded from Safeguards"
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of constraints to use"
+ },
+ "level": {
+ "type": {
+ "$ref": "#/345"
+ },
+ "flags": 1,
+ "description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces"
+ },
+ "excludedNamespaces": {
+ "type": {
+ "$ref": "#/346"
+ },
+ "flags": 0,
+ "description": "List of namespaces excluded from Safeguards checks"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Off"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enforcement"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/343"
+ },
+ {
+ "$ref": "#/344"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServiceMeshProfile",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/350"
+ },
+ "flags": 1,
+ "description": "Mode of the service mesh."
+ },
+ "istio": {
+ "type": {
+ "$ref": "#/351"
+ },
+ "flags": 0,
+ "description": "Istio service mesh configuration."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Istio"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioServiceMesh",
+ "properties": {
+ "components": {
+ "type": {
+ "$ref": "#/352"
+ },
+ "flags": 0,
+ "description": "Istio components configuration."
+ },
+ "certificateAuthority": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca"
+ },
+ "revisions": {
+ "type": {
+ "$ref": "#/363"
+ },
+ "flags": 0,
+ "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioComponents",
+ "properties": {
+ "ingressGateways": {
+ "type": {
+ "$ref": "#/357"
+ },
+ "flags": 0,
+ "description": "Istio ingress gateways."
+ },
+ "egressGateways": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 0,
+ "description": "Istio egress gateways."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioIngressGateway",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 1,
+ "description": "Mode of an ingress gateway."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable the ingress gateway."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/355"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/353"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioEgressGateway",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable the egress gateway."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/359"
+ },
+ "flags": 1,
+ "description": "Name of the Istio add-on egress gateway."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Namespace that the Istio add-on egress gateway should be deployed in. If unspecified, the default is aks-istio-egress."
+ },
+ "gatewayConfigurationName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the gateway configuration custom resource for the Istio add-on egress gateway. Must be specified when enabling the Istio egress gateway. Must be deployed in the same namespace that the Istio egress gateway will be deployed in."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/358"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioCertificateAuthority",
+ "properties": {
+ "plugin": {
+ "type": {
+ "$ref": "#/362"
+ },
+ "flags": 0,
+ "description": "Plugin certificates information for Service Mesh."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioPluginCertificateAuthority",
+ "properties": {
+ "keyVaultId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the Key Vault."
+ },
+ "certObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate object name in Azure Key Vault."
+ },
+ "keyObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate private key object name in Azure Key Vault."
+ },
+ "rootCertObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Root certificate object name in Azure Key Vault."
+ },
+ "certChainObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Certificate chain object name in Azure Key Vault."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterMetricsProfile",
+ "properties": {
+ "costAnalysis": {
+ "type": {
+ "$ref": "#/365"
+ },
+ "flags": 0,
+ "description": "The cost analysis configuration for the cluster"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterCostAnalysis",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAIToolchainOperatorProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if AI toolchain operator enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNodeProvisioningProfile",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 0,
+ "description": "Once the mode it set to Auto, it cannot be changed back to Manual."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Manual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Auto"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterBootstrapProfile",
+ "properties": {
+ "artifactSource": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 0,
+ "description": "The source where the artifacts are downloaded from."
+ },
+ "containerRegistryId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cache"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Direct"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/372"
+ },
+ {
+ "$ref": "#/373"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStatus",
+ "properties": {
+ "provisioningError": {
+ "type": {
+ "$ref": "#/145"
+ },
+ "flags": 2,
+ "description": "Preserves the detailed info of failure. If there was no error, this field is omitted."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/382"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/387"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/384"
+ },
+ {
+ "$ref": "#/385"
+ },
+ {
+ "$ref": "#/386"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/389"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/392"
+ },
+ "flags": 0,
+ "description": "Properties of a default maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceConfigurationProperties",
+ "properties": {
+ "timeInWeek": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 0,
+ "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries."
+ },
+ "notAllowedTime": {
+ "type": {
+ "$ref": "#/406"
+ },
+ "flags": 0,
+ "description": "Time slots on which upgrade is not allowed."
+ },
+ "maintenanceWindow": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 0,
+ "description": "Maintenance window for the maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeInWeek",
+ "properties": {
+ "day": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "The day of the week."
+ },
+ "hourSlots": {
+ "type": {
+ "$ref": "#/403"
+ },
+ "flags": 0,
+ "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/394"
+ },
+ {
+ "$ref": "#/395"
+ },
+ {
+ "$ref": "#/396"
+ },
+ {
+ "$ref": "#/397"
+ },
+ {
+ "$ref": "#/398"
+ },
+ {
+ "$ref": "#/399"
+ },
+ {
+ "$ref": "#/400"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 23
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/402"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/393"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The start of a time span"
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end of a time span"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/405"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceWindow",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/408"
+ },
+ "flags": 1,
+ "description": "Recurrence schedule for the maintenance window."
+ },
+ "durationHours": {
+ "type": {
+ "$ref": "#/439"
+ },
+ "flags": 1,
+ "description": "Length of maintenance window range from 4 to 24 hours."
+ },
+ "utcOffset": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 0,
+ "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/441"
+ },
+ "flags": 1,
+ "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'."
+ },
+ "notAllowedDates": {
+ "type": {
+ "$ref": "#/443"
+ },
+ "flags": 0,
+ "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Schedule",
+ "properties": {
+ "daily": {
+ "type": {
+ "$ref": "#/409"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every day' or 'recur every 3 days'."
+ },
+ "weekly": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'."
+ },
+ "absoluteMonthly": {
+ "type": {
+ "$ref": "#/421"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'."
+ },
+ "relativeMonthly": {
+ "type": {
+ "$ref": "#/424"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DailySchedule",
+ "properties": {
+ "intervalDays": {
+ "type": {
+ "$ref": "#/410"
+ },
+ "flags": 1,
+ "description": "Specifies the number of days between each set of occurrences."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 7
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WeeklySchedule",
+ "properties": {
+ "intervalWeeks": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 1,
+ "description": "Specifies the number of weeks between each set of occurrences."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/420"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 4
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/413"
+ },
+ {
+ "$ref": "#/414"
+ },
+ {
+ "$ref": "#/415"
+ },
+ {
+ "$ref": "#/416"
+ },
+ {
+ "$ref": "#/417"
+ },
+ {
+ "$ref": "#/418"
+ },
+ {
+ "$ref": "#/419"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AbsoluteMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/422"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "dayOfMonth": {
+ "type": {
+ "$ref": "#/423"
+ },
+ "flags": 1,
+ "description": "The date of the month."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 6
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 31
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RelativeMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/422"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "weekIndex": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 1,
+ "description": "Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/438"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/425"
+ },
+ {
+ "$ref": "#/426"
+ },
+ {
+ "$ref": "#/427"
+ },
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/429"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/435"
+ },
+ {
+ "$ref": "#/436"
+ },
+ {
+ "$ref": "#/437"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 24
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^\\d{2}:\\d{2}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DateSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date of the date span."
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date of the date span."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/442"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/391"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 12,
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/447"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/449"
+ },
+ "flags": 0,
+ "description": "Properties of an agent pool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfileProperties",
+ "properties": {
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/452"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podIPAllocationMode": {
+ "type": {
+ "$ref": "#/462"
+ },
+ "flags": 0,
+ "description": "The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'."
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/465"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/476"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/480"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/484"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/485"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "enableCustomCATrust": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/488"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/491"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/492"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/493"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/494"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "nodeInitializationTaints": {
+ "type": {
+ "$ref": "#/495"
+ },
+ "flags": 0,
+ "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`"
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/501"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The GPU settings of an agent pool."
+ },
+ "artifactStreamingProfile": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "Configuration for using artifact streaming on AKS."
+ },
+ "virtualMachinesProfile": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Specifications on VirtualMachines agent pool."
+ },
+ "virtualMachineNodesStatus": {
+ "type": {
+ "$ref": "#/502"
+ },
+ "flags": 0,
+ "description": "The status of nodes in a VirtualMachines agent pool."
+ },
+ "gatewayProfile": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 0,
+ "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "Contains read-only information about the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/450"
+ },
+ {
+ "$ref": "#/451"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/453"
+ },
+ {
+ "$ref": "#/454"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KataMshvVmIsolation"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/456"
+ },
+ {
+ "$ref": "#/457"
+ },
+ {
+ "$ref": "#/458"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DynamicIndividual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StaticBlock"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/460"
+ },
+ {
+ "$ref": "#/461"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/463"
+ },
+ {
+ "$ref": "#/464"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/466"
+ },
+ {
+ "$ref": "#/467"
+ },
+ {
+ "$ref": "#/468"
+ },
+ {
+ "$ref": "#/469"
+ },
+ {
+ "$ref": "#/470"
+ },
+ {
+ "$ref": "#/471"
+ },
+ {
+ "$ref": "#/472"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/474"
+ },
+ {
+ "$ref": "#/475"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachines"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/477"
+ },
+ {
+ "$ref": "#/478"
+ },
+ {
+ "$ref": "#/479"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Gateway"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/481"
+ },
+ {
+ "$ref": "#/482"
+ },
+ {
+ "$ref": "#/483"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/486"
+ },
+ {
+ "$ref": "#/487"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/489"
+ },
+ {
+ "$ref": "#/490"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/496"
+ },
+ {
+ "$ref": "#/497"
+ },
+ {
+ "$ref": "#/498"
+ },
+ {
+ "$ref": "#/499"
+ },
+ {
+ "$ref": "#/500"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/140"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/448"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/504"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/505"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/507"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/513"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/514"
+ },
+ "flags": 0,
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/515"
+ },
+ "flags": 1,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/508"
+ },
+ {
+ "$ref": "#/509"
+ },
+ {
+ "$ref": "#/510"
+ },
+ {
+ "$ref": "#/511"
+ },
+ {
+ "$ref": "#/512"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the private endpoint"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/520"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The private link service connection description."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/516"
+ },
+ {
+ "$ref": "#/517"
+ },
+ {
+ "$ref": "#/518"
+ },
+ {
+ "$ref": "#/519"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/506"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/snapshots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/snapshots",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/522"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/523"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/525"
+ },
+ "flags": 0,
+ "description": "Properties of a snapshot."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/540"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SnapshotProperties",
+ "properties": {
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "type": {
+ "$ref": "#/528"
+ },
+ "flags": 0,
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of Kubernetes."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/531"
+ },
+ "flags": 2,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSku": {
+ "type": {
+ "$ref": "#/539"
+ },
+ "flags": 2,
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The size of the VM."
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2,
+ "description": "Whether to use a FIPS-enabled OS."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodePool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedCluster"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/526"
+ },
+ {
+ "$ref": "#/527"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/529"
+ },
+ {
+ "$ref": "#/530"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/532"
+ },
+ {
+ "$ref": "#/533"
+ },
+ {
+ "$ref": "#/534"
+ },
+ {
+ "$ref": "#/535"
+ },
+ {
+ "$ref": "#/536"
+ },
+ {
+ "$ref": "#/537"
+ },
+ {
+ "$ref": "#/538"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/snapshots@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/524"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedclustersnapshots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedclustersnapshots",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/542"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/543"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/545"
+ },
+ "flags": 0,
+ "description": "Properties of a managed cluster snapshot."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/568"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSnapshotProperties",
+ "properties": {
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "type": {
+ "$ref": "#/548"
+ },
+ "flags": 0,
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "managedClusterPropertiesReadOnly": {
+ "type": {
+ "$ref": "#/549"
+ },
+ "flags": 2,
+ "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodePool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedCluster"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/546"
+ },
+ {
+ "$ref": "#/547"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesForSnapshot",
+ "properties": {
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The current kubernetes version."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The current managed cluster sku."
+ },
+ "enableRbac": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/550"
+ },
+ "flags": 2,
+ "description": "The current network profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkProfileForSnapshot",
+ "properties": {
+ "networkPlugin": {
+ "type": {
+ "$ref": "#/554"
+ },
+ "flags": 0,
+ "description": "networkPlugin for managed cluster snapshot."
+ },
+ "networkPluginMode": {
+ "type": {
+ "$ref": "#/556"
+ },
+ "flags": 0,
+ "description": "NetworkPluginMode for managed cluster snapshot."
+ },
+ "networkPolicy": {
+ "type": {
+ "$ref": "#/561"
+ },
+ "flags": 0,
+ "description": "networkPolicy for managed cluster snapshot."
+ },
+ "networkMode": {
+ "type": {
+ "$ref": "#/564"
+ },
+ "flags": 0,
+ "description": "networkMode for managed cluster snapshot."
+ },
+ "loadBalancerSku": {
+ "type": {
+ "$ref": "#/567"
+ },
+ "flags": 0,
+ "description": "loadBalancerSku for managed cluster snapshot."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "kubenet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/551"
+ },
+ {
+ "$ref": "#/552"
+ },
+ {
+ "$ref": "#/553"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "overlay"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/555"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "calico"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/557"
+ },
+ {
+ "$ref": "#/558"
+ },
+ {
+ "$ref": "#/559"
+ },
+ {
+ "$ref": "#/560"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "transparent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "bridge"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/562"
+ },
+ {
+ "$ref": "#/563"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/565"
+ },
+ {
+ "$ref": "#/566"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedclustersnapshots@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/544"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^([A-Za-z0-9-])+$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/570"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/571"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/572"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/574"
+ },
+ "flags": 1,
+ "description": "Properties for trusted access role binding"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrustedAccessRoleBindingProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/580"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of trusted access role binding."
+ },
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ARM resource ID of source resource that trusted access is configured for."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/581"
+ },
+ "flags": 1,
+ "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/575"
+ },
+ {
+ "$ref": "#/576"
+ },
+ {
+ "$ref": "#/577"
+ },
+ {
+ "$ref": "#/578"
+ },
+ {
+ "$ref": "#/579"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/573"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/loadBalancers"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/loadBalancers",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/583"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/584"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/586"
+ },
+ "flags": 0,
+ "description": "The properties of the load balancer."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LoadBalancerProperties",
+ "properties": {
+ "primaryAgentPoolName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer."
+ },
+ "allowServicePlacement": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it."
+ },
+ "serviceLabelSelector": {
+ "type": {
+ "$ref": "#/587"
+ },
+ "flags": 0,
+ "description": "Only services that must match this selector can be placed on this load balancer."
+ },
+ "serviceNamespaceSelector": {
+ "type": {
+ "$ref": "#/587"
+ },
+ "flags": 0,
+ "description": "Services created in namespaces that match the selector can be placed on this load balancer."
+ },
+ "nodeSelector": {
+ "type": {
+ "$ref": "#/587"
+ },
+ "flags": 0,
+ "description": "Nodes that match this selector will be possible members of this load balancer."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LabelSelector",
+ "properties": {
+ "matchLabels": {
+ "type": {
+ "$ref": "#/588"
+ },
+ "flags": 0,
+ "description": "matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is `key`, the operator is `In`, and the values array contains only `value`. The requirements are ANDed."
+ },
+ "matchExpressions": {
+ "type": {
+ "$ref": "#/596"
+ },
+ "flags": 0,
+ "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LabelSelectorRequirement",
+ "properties": {
+ "key": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "key is the label key that the selector applies to."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/594"
+ },
+ "flags": 0,
+ "description": "operator represents a key's relationship to a set of values. Valid operators are In and NotIn"
+ },
+ "values": {
+ "type": {
+ "$ref": "#/595"
+ },
+ "flags": 0,
+ "description": "values is an array of string values, the values array must be non-empty."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotIn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Exists"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DoesNotExist"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/590"
+ },
+ {
+ "$ref": "#/591"
+ },
+ {
+ "$ref": "#/592"
+ },
+ {
+ "$ref": "#/593"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/589"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/loadBalancers@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/585"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/guardrailsVersions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/guardrailsVersions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/598"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/599"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/600"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/602"
+ },
+ "flags": 2,
+ "description": "Whether the version is default or not and support info."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GuardrailsAvailableVersionsProperties",
+ "properties": {
+ "isDefaultVersion": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ },
+ "support": {
+ "type": {
+ "$ref": "#/605"
+ },
+ "flags": 2,
+ "description": "Whether the version is preview or stable."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Preview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/603"
+ },
+ {
+ "$ref": "#/604"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/guardrailsVersions@2025-01-02-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/601"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/safeguardsVersions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/safeguardsVersions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/598"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/607"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/608"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/610"
+ },
+ "flags": 2,
+ "description": "Whether the version is default or not and support info."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SafeguardsAvailableVersionsProperties",
+ "properties": {
+ "isDefaultVersion": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ },
+ "support": {
+ "type": {
+ "$ref": "#/613"
+ },
+ "flags": 2,
+ "description": "Whether the version is preview or stable."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Preview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/611"
+ },
+ {
+ "$ref": "#/612"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/safeguardsVersions@2025-01-02-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/609"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/meshRevisionProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/615"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/616"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/617"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/619"
+ },
+ "flags": 2,
+ "description": "Mesh revision profile properties for a mesh"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevisionProfileProperties",
+ "properties": {
+ "meshRevisions": {
+ "type": {
+ "$ref": "#/625"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevision",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/621"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/624"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CompatibleVersions",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The product/service name."
+ },
+ "versions": {
+ "type": {
+ "$ref": "#/623"
+ },
+ "flags": 0,
+ "description": "Product/service versions compatible with a service mesh add-on revision."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/622"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/620"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles@2025-01-02-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/618"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/615"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/627"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/628"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/630"
+ },
+ "flags": 2,
+ "description": "Mesh upgrade profile properties for a major.minor release."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshUpgradeProfileProperties",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/631"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/632"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/622"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/629"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools/machines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/634"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/635"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/636"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/638"
+ },
+ "flags": 2,
+ "description": "The properties of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineProperties",
+ "properties": {
+ "network": {
+ "type": {
+ "$ref": "#/639"
+ },
+ "flags": 2,
+ "description": "network properties of the machine"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Arm resource id of the machine. It can be used to GET underlying VM Instance"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineNetworkProperties",
+ "properties": {
+ "ipAddresses": {
+ "type": {
+ "$ref": "#/644"
+ },
+ "flags": 2,
+ "description": "IPv4, IPv6 addresses of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineIpAddress",
+ "properties": {
+ "family": {
+ "type": {
+ "$ref": "#/643"
+ },
+ "flags": 2,
+ "description": "To determine if address belongs IPv4 or IPv6 family"
+ },
+ "ip": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "IPv4 or IPv6 address of the machine"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/641"
+ },
+ {
+ "$ref": "#/642"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/640"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines@2025-01-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/637"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAccessProfile",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/647"
+ },
+ "flags": 0,
+ "description": "AccessProfile of a managed cluster."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/648"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessProfile",
+ "properties": {
+ "kubeConfig": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 0,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters/accessProfiles",
+ "apiVersion": "2025-01-02-preview",
+ "output": {
+ "$ref": "#/646"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResults",
+ "properties": {
+ "kubeconfigs": {
+ "type": {
+ "$ref": "#/652"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResult",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/651"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterAdminCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "output": {
+ "$ref": "#/650"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "output": {
+ "$ref": "#/650"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterMonitoringUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "output": {
+ "$ref": "#/650"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetServicePrincipalProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "input": {
+ "$ref": "#/158"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetAADProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "input": {
+ "$ref": "#/261"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters",
+ "apiVersion": "2025-01-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateClusterCertificates",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateServiceAccountSigningKeys",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stop",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandRequest",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The command to run."
+ },
+ "context": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64 encoded zip file containing the files required by the command."
+ },
+ "clusterToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AuthToken issued for AKS AAD Server App."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command id."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/665"
+ },
+ "flags": 0,
+ "description": "Properties of command result."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandResultProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "provisioning State"
+ },
+ "exitCode": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 2,
+ "description": "The exit code of the command"
+ },
+ "startedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command started."
+ },
+ "finishedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command finished."
+ },
+ "logs": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command output."
+ },
+ "reason": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "An explanation of why provisioningState is set to failed (if so)."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "runCommand",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "output": {
+ "$ref": "#/664"
+ },
+ "input": {
+ "$ref": "#/663"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RebalanceLoadBalancersRequestBody",
+ "properties": {
+ "loadBalancerNames": {
+ "type": {
+ "$ref": "#/668"
+ },
+ "flags": 0,
+ "description": "The load balancer names list."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rebalanceLoadBalancers",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "input": {
+ "$ref": "#/667"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resolvePrivateLinkServiceId",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-01-02-preview",
+ "output": {
+ "$ref": "#/286"
+ },
+ "input": {
+ "$ref": "#/286"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters/agentPools",
+ "apiVersion": "2025-01-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolDeleteMachinesParameter",
+ "properties": {
+ "machineNames": {
+ "type": {
+ "$ref": "#/673"
+ },
+ "flags": 1,
+ "description": "The agent pool machine names."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deleteMachines",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-01-02-preview",
+ "input": {
+ "$ref": "#/672"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "upgradeNodeImageVersion",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-01-02-preview"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/containerservice/microsoft.containerservice/2025-02-01/types.json b/internal/azure/generated/containerservice/microsoft.containerservice/2025-02-01/types.json
new file mode 100644
index 000000000..3c770f9a9
--- /dev/null
+++ b/internal/azure/generated/containerservice/microsoft.containerservice/2025-02-01/types.json
@@ -0,0 +1,7255 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The managed cluster SKU."
+ },
+ "extendedLocation": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "The extended location of the Virtual Machine."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The identity of the managed cluster, if configured."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "Properties of a managed cluster."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSKU",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The name of a managed cluster SKU."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Base"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Free"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExtendedLocation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EdgeZone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of the system assigned identity which is used by master components."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant id of the system assigned identity which is used by master components."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 0,
+ "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity)."
+ },
+ "delegatedResources": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 0,
+ "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResource",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ARM resource id of the delegated resource - internal use only."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 0,
+ "description": "The tenant id of the delegated resource - internal use only."
+ },
+ "referralResource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The delegation id of the referral delegation (optional) - internal use only."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source resource location - internal use only."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResources",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/20"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/23"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 2,
+ "description": "The Power State of the cluster."
+ },
+ "maxAgentPools": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 2,
+ "description": "The max number of agent pools for the managed cluster."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details."
+ },
+ "currentKubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used."
+ },
+ "dnsPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdnSubdomain": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of the master pool."
+ },
+ "privateFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of private cluster."
+ },
+ "azurePortalFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly."
+ },
+ "agentPoolProfiles": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The agent pool properties."
+ },
+ "linuxProfile": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "The profile for Linux VMs in the Managed Cluster."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/112"
+ },
+ "flags": 0,
+ "description": "The profile for Windows VMs in the Managed Cluster."
+ },
+ "servicePrincipalProfile": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs."
+ },
+ "addonProfiles": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The profile of managed cluster add-on."
+ },
+ "podIdentityProfile": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 0,
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration."
+ },
+ "oidcIssuerProfile": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "nodeResourceGroup": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the resource group containing agent pool nodes."
+ },
+ "nodeResourceGroupProfile": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "Profile of the node resource group configuration."
+ },
+ "enableRBAC": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Kubernetes Role-Based Access Control."
+ },
+ "supportPlan": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'."
+ },
+ "enablePodSecurityPolicy": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The network configuration profile."
+ },
+ "aadProfile": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 0,
+ "description": "The Azure Active Directory configuration."
+ },
+ "autoUpgradeProfile": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "The auto upgrade configuration."
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading a cluster."
+ },
+ "autoScalerProfile": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "Parameters to be applied to the cluster-autoscaler when enabled"
+ },
+ "apiServerAccessProfile": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "The access profile for managed cluster API server."
+ },
+ "diskEncryptionSetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'"
+ },
+ "identityProfile": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is \"kubeletidentity\", with value of \"resourceId\": \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}\"."
+ },
+ "privateLinkResources": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 0,
+ "description": "Private link resources associated with the cluster."
+ },
+ "disableLocalAccounts": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)."
+ },
+ "httpProxyConfig": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 0,
+ "description": "Configurations for provisioning the cluster with HTTP proxy servers."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "Security profile for the managed cluster."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/246"
+ },
+ "flags": 0,
+ "description": "Storage profile for the managed cluster."
+ },
+ "ingressProfile": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 0,
+ "description": "Ingress profile for the managed cluster."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 0,
+ "description": "Allow or deny public network access for AKS"
+ },
+ "workloadAutoScalerProfile": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 0,
+ "description": "Workload Auto-scaler profile for the managed cluster."
+ },
+ "azureMonitorProfile": {
+ "type": {
+ "$ref": "#/266"
+ },
+ "flags": 0,
+ "description": "Azure Monitor addon profiles for monitoring the managed cluster."
+ },
+ "serviceMeshProfile": {
+ "type": {
+ "$ref": "#/269"
+ },
+ "flags": 0,
+ "description": "Service mesh profile for a managed cluster."
+ },
+ "resourceUID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)"
+ },
+ "metricsProfile": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 0,
+ "description": "Optional cluster metrics configuration."
+ },
+ "bootstrapProfile": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster bootstrap configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PowerState",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Tells whether the cluster is Running or Stopped"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/27"
+ },
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfile",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 1,
+ "description": "Windows agent pool names must be 6 characters or less."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/36"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 0,
+ "description": "GPU settings for the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 2048
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/53"
+ },
+ {
+ "$ref": "#/54"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/59"
+ },
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolUpgradeSettings",
+ "properties": {
+ "maxSurge": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
+ },
+ "drainTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes."
+ },
+ "nodeSoakDurationInMinutes": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 1440
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 30
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubeletConfig",
+ "properties": {
+ "cpuManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'."
+ },
+ "cpuCfsQuota": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "cpuCfsQuotaPeriod": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'."
+ },
+ "imageGcHighThreshold": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "To disable image garbage collection, set to 100. The default is 85%"
+ },
+ "imageGcLowThreshold": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%"
+ },
+ "topologyManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'."
+ },
+ "allowedUnsafeSysctls": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 0,
+ "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)."
+ },
+ "failSwapOn": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node."
+ },
+ "containerLogMaxSizeMB": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated."
+ },
+ "containerLogMaxFiles": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2."
+ },
+ "podMaxPids": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of processes per pod."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxOSConfig",
+ "properties": {
+ "sysctls": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 0,
+ "description": "Sysctl settings for Linux agent nodes."
+ },
+ "transparentHugePageEnabled": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "transparentHugePageDefrag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "swapFileSizeMB": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The size in MB of a swap file that will be created on each node."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SysctlConfig",
+ "properties": {
+ "netCoreSomaxconn": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.somaxconn."
+ },
+ "netCoreNetdevMaxBacklog": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.netdev_max_backlog."
+ },
+ "netCoreRmemDefault": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_default."
+ },
+ "netCoreRmemMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_max."
+ },
+ "netCoreWmemDefault": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_default."
+ },
+ "netCoreWmemMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_max."
+ },
+ "netCoreOptmemMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.optmem_max."
+ },
+ "netIpv4TcpMaxSynBacklog": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog."
+ },
+ "netIpv4TcpMaxTwBuckets": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets."
+ },
+ "netIpv4TcpFinTimeout": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_fin_timeout."
+ },
+ "netIpv4TcpKeepaliveTime": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_time."
+ },
+ "netIpv4TcpKeepaliveProbes": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_probes."
+ },
+ "netIpv4TcpkeepaliveIntvl": {
+ "type": {
+ "$ref": "#/80"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl."
+ },
+ "netIpv4TcpTwReuse": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_tw_reuse."
+ },
+ "netIpv4IpLocalPortRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.ip_local_port_range."
+ },
+ "netIpv4NeighDefaultGcThresh1": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1."
+ },
+ "netIpv4NeighDefaultGcThresh2": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2."
+ },
+ "netIpv4NeighDefaultGcThresh3": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3."
+ },
+ "netNetfilterNfConntrackMax": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_max."
+ },
+ "netNetfilterNfConntrackBuckets": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_buckets."
+ },
+ "fsInotifyMaxUserWatches": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.inotify.max_user_watches."
+ },
+ "fsFileMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.file-max."
+ },
+ "fsAioMaxNr": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.aio-max-nr."
+ },
+ "fsNrOpen": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.nr_open."
+ },
+ "kernelThreadsMax": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting kernel.threads-max."
+ },
+ "vmMaxMapCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.max_map_count."
+ },
+ "vmSwappiness": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.swappiness."
+ },
+ "vmVfsCachePressure": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.vfs_cache_pressure."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 10,
+ "maxValue": 90
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 131072,
+ "maxValue": 2097152
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 65536,
+ "maxValue": 524288
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreationData",
+ "properties": {
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is the ARM ID of the source object to be used to create the target object."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolNetworkProfile",
+ "properties": {
+ "nodePublicIPTags": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "IPTags of instance-level public IPs."
+ },
+ "allowedHostPorts": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 0,
+ "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap."
+ },
+ "applicationSecurityGroups": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "The IDs of the application security groups which agent pool will associate when created."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IPTag",
+ "properties": {
+ "ipTagType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP tag type. Example: RoutingPreference."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The value of the IP tag associated with the public IP. Example: Internet."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/91"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PortRange",
+ "properties": {
+ "portStart": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd."
+ },
+ "portEnd": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart."
+ },
+ "protocol": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "The network protocol of the port."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 65535
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TCP"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UDP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/96"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/93"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolWindowsProfile",
+ "properties": {
+ "disableOutboundNat": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolSecurityProfile",
+ "properties": {
+ "enableVTPM": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ },
+ "enableSecureBoot": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GPUProfile",
+ "properties": {
+ "driver": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "Whether to install GPU drivers. When it's not specified, default is Install."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Install"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/31"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceLinuxProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 1,
+ "description": "The administrator username to use for Linux VMs."
+ },
+ "ssh": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 1,
+ "description": "The SSH configuration for Linux-based VMs running on Azure."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshConfiguration",
+ "properties": {
+ "publicKeys": {
+ "type": {
+ "$ref": "#/111"
+ },
+ "flags": 1,
+ "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshPublicKey",
+ "properties": {
+ "keyData": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/110"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWindowsProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Specifies the name of the administrator account.
**Max-length:** 20 characters"
+ },
+ "adminPassword": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length:** 8 characters
**Max-length:** 123 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\""
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details."
+ },
+ "enableCSIProxy": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)."
+ },
+ "gmsaProfile": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "The Windows gMSA Profile in the Managed Cluster."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows_Server"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/114"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsGmsaProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Specifies whether to enable Windows gMSA in the managed cluster."
+ },
+ "dnsServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the DNS server for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ },
+ "rootDomainName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the root domain name for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterServicePrincipalProfile",
+ "properties": {
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ID for the service principal."
+ },
+ "secret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The secret password associated with the service principal in plain text."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether the add-on is enabled or not."
+ },
+ "config": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 0,
+ "description": "Key-value pairs for configuring an add-on."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 2,
+ "description": "Information of user assigned identity used by this add-on."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileConfig",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAddonProfiles",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/118"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether the pod identity addon is enabled."
+ },
+ "allowNetworkPluginKubenet": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 0,
+ "description": "The pod identities to use in the cluster."
+ },
+ "userAssignedIdentityExceptions": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 0,
+ "description": "The pod identity exceptions to allow."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentity",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity."
+ },
+ "bindingSelector": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The binding selector to use for the AzureIdentityBinding resource."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 1,
+ "description": "The user assigned identity details."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/131"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of the pod identity."
+ },
+ "provisioningInfo": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Assigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/125"
+ },
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/128"
+ },
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningInfo",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 0,
+ "description": "Pod identity assignment error (if any)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningErrorBody",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "A list of additional details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/134"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/123"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityException",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity exception."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity exception."
+ },
+ "podLabels": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 1,
+ "description": "The pod labels to match."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityExceptionPodLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/137"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterOidcIssuerProfile",
+ "properties": {
+ "issuerURL": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The OIDC issuer url of the Managed Cluster."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether the OIDC issuer is enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNodeResourceGroupProfile",
+ "properties": {
+ "restrictionLevel": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unrestricted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesOfficial"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AKSLongTermSupport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfile",
+ "properties": {
+ "networkPlugin": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "networkPluginMode": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 0,
+ "description": "The mode the network plugin should use."
+ },
+ "networkPolicy": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "networkMode": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "networkDataplane": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "Network dataplane used in the Kubernetes cluster."
+ },
+ "advancedNetworking": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 0,
+ "description": "Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking."
+ },
+ "podCidr": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used."
+ },
+ "serviceCidr": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges."
+ },
+ "dnsServiceIP": {
+ "type": {
+ "$ref": "#/170"
+ },
+ "flags": 0,
+ "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr."
+ },
+ "outboundType": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)."
+ },
+ "loadBalancerSku": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 0,
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "loadBalancerProfile": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster load balancer."
+ },
+ "natGatewayProfile": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster NAT gateway."
+ },
+ "podCidrs": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking."
+ },
+ "serviceCidrs": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges."
+ },
+ "ipFamilies": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "kubenet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "overlay"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/153"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "calico"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ },
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "transparent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "bridge"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/163"
+ },
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworking",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false."
+ },
+ "observability": {
+ "type": {
+ "$ref": "#/167"
+ },
+ "flags": 0,
+ "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts."
+ },
+ "security": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "Security profile to enable security features on cilium based cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingObservability",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingSecurity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "loadBalancer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userDefinedRouting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "managedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userAssignedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfile",
+ "properties": {
+ "managedOutboundIPs": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 0,
+ "description": "Desired managed outbound IPs for the cluster load balancer."
+ },
+ "outboundIPPrefixes": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP Prefix resources for the cluster load balancer."
+ },
+ "outboundIPs": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP resources for the cluster load balancer."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster load balancer."
+ },
+ "allocatedOutboundPorts": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 0,
+ "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes."
+ },
+ "enableMultipleStandardLoadBalancers": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Enable multiple standard load balancers per AKS cluster or not."
+ },
+ "backendPoolType": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "The type of the managed inbound Load Balancer BackendPool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileManagedOutboundIPs",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/182"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1."
+ },
+ "countIPv6": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 100
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 100
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPPrefixes",
+ "properties": {
+ "publicIPPrefixes": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 0,
+ "description": "A list of public IP prefix resources."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The fully qualified Azure resource id."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPs",
+ "properties": {
+ "publicIPs": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "A list of public IP resources."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 64000
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 120
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIPConfiguration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNATGatewayProfile",
+ "properties": {
+ "managedOutboundIPProfile": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 0,
+ "description": "Profile of the managed outbound IP resources of the cluster NAT gateway."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster NAT gateway."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterManagedOutboundIPProfile",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/197"
+ },
+ "flags": 0,
+ "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 16
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/201"
+ },
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/203"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAADProfile",
+ "properties": {
+ "managed": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable managed AAD."
+ },
+ "enableAzureRBAC": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure RBAC for Kubernetes authorization."
+ },
+ "adminGroupObjectIDs": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "The list of AAD group object IDs that will have admin role of the cluster."
+ },
+ "clientAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppSecret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "tenantID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAutoUpgradeProfile",
+ "properties": {
+ "upgradeChannel": {
+ "type": {
+ "$ref": "#/213"
+ },
+ "flags": 0,
+ "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)."
+ },
+ "nodeOSUpgradeChannel": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 0,
+ "description": "Manner in which the OS on your nodes is updated. The default is NodeImage."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "rapid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "stable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "patch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "node-image"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/208"
+ },
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/211"
+ },
+ {
+ "$ref": "#/212"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unmanaged"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeImage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecurityPatch"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/214"
+ },
+ {
+ "$ref": "#/215"
+ },
+ {
+ "$ref": "#/216"
+ },
+ {
+ "$ref": "#/217"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterUpgradeSettings",
+ "properties": {
+ "overrideSettings": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 0,
+ "description": "Settings for overrides."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpgradeOverrideSettings",
+ "properties": {
+ "forceUpgrade": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution."
+ },
+ "until": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAutoScalerProfile",
+ "properties": {
+ "balance-similar-node-groups": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'true' and 'false'"
+ },
+ "daemonset-eviction-for-empty-nodes": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "daemonset-eviction-for-occupied-nodes": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "ignore-daemonsets-utilization": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions."
+ },
+ "expander": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information."
+ },
+ "max-empty-bulk-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 10."
+ },
+ "max-graceful-termination-sec": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 600."
+ },
+ "max-node-provision-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "max-total-unready-percentage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 45. The maximum is 100 and the minimum is 0."
+ },
+ "new-pod-scale-up-delay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)."
+ },
+ "ok-total-unready-count": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This must be an integer. The default is 3."
+ },
+ "scan-interval": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10'. Values must be an integer number of seconds."
+ },
+ "scale-down-delay-after-add": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-failure": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unneeded-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unready-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-utilization-threshold": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '0.5'."
+ },
+ "skip-nodes-with-local-storage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "skip-nodes-with-system-pods": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "least-waste"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "most-pods"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "priority"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "random"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/222"
+ },
+ {
+ "$ref": "#/223"
+ },
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAPIServerAccessProfile",
+ "properties": {
+ "authorizedIPRanges": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)."
+ },
+ "enablePrivateCluster": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)."
+ },
+ "privateDNSZone": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'."
+ },
+ "enablePrivateClusterPublicFQDN": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to create additional public FQDN for private cluster or not."
+ },
+ "disableRunCommand": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to disable run command for the cluster or not."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesIdentityProfile",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/124"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the private link resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the private link resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource type."
+ },
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The group ID of the resource."
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "The RequiredMembers of the resource"
+ },
+ "privateLinkServiceID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The private link service ID of the resource, this field is exposed only to NRP internally."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/230"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterHttpProxyConfig",
+ "properties": {
+ "httpProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP proxy server endpoint to use."
+ },
+ "httpsProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTPS proxy server endpoint to use."
+ },
+ "noProxy": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 0,
+ "description": "The endpoints that should not go through proxy."
+ },
+ "trustedCa": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Alternative CA cert to use for connecting to proxy servers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfile",
+ "properties": {
+ "defender": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "azureKeyVaultKms": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 0,
+ "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile."
+ },
+ "workloadIdentity": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 0,
+ "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details."
+ },
+ "imageCleaner": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 0,
+ "description": "Image Cleaner settings for the security profile."
+ },
+ "customCATrustCertificates": {
+ "type": {
+ "$ref": "#/245"
+ },
+ "flags": 0,
+ "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefender",
+ "properties": {
+ "logAnalyticsWorkspaceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty."
+ },
+ "securityMonitoring": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender threat detection for Cloud settings for the security profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityMonitoring",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Defender threat detection"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureKeyVaultKms",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure Key Vault key management service. The default is false."
+ },
+ "keyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
+ },
+ "keyVaultNetworkAccess": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 0,
+ "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`."
+ },
+ "keyVaultResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Public"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Private"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/240"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileWorkloadIdentity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable workload identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileImageCleaner",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Image Cleaner on AKS cluster."
+ },
+ "intervalHours": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Image Cleaner scanning interval in hours."
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/244"
+ },
+ "maxLength": 10
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfile",
+ "properties": {
+ "diskCSIDriver": {
+ "type": {
+ "$ref": "#/247"
+ },
+ "flags": 0,
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "fileCSIDriver": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "snapshotController": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "blobCSIDriver": {
+ "type": {
+ "$ref": "#/250"
+ },
+ "flags": 0,
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileDiskCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureDisk CSI Driver. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileFileCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureFile CSI Driver. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileSnapshotController",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable Snapshot Controller. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileBlobCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureBlob CSI Driver. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfile",
+ "properties": {
+ "webAppRouting": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileWebAppRouting",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable the Application Routing add-on."
+ },
+ "dnsZoneResourceIds": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group."
+ },
+ "nginx": {
+ "type": {
+ "$ref": "#/254"
+ },
+ "flags": 0,
+ "description": "Configuration for the default NginxIngressController. See more at https://learn.microsoft.com/en-us/azure/aks/app-routing-nginx-configuration#the-default-nginx-ingress-controller."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 2,
+ "description": "Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 5
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileNginx",
+ "properties": {
+ "defaultIngressControllerType": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "Ingress type for the default NginxIngressController custom resource"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AnnotationControlled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/257"
+ },
+ {
+ "$ref": "#/258"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/260"
+ },
+ {
+ "$ref": "#/261"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfile",
+ "properties": {
+ "keda": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 0,
+ "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile."
+ },
+ "verticalPodAutoscaler": {
+ "type": {
+ "$ref": "#/265"
+ },
+ "flags": 0,
+ "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileKeda",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable KEDA."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable VPA. Default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfile",
+ "properties": {
+ "metrics": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 0,
+ "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileMetrics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling."
+ },
+ "kubeStateMetrics": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 0,
+ "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileKubeStateMetrics",
+ "properties": {
+ "metricLabelsAllowlist": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels."
+ },
+ "metricAnnotationsAllowList": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServiceMeshProfile",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/272"
+ },
+ "flags": 1,
+ "description": "Mode of the service mesh."
+ },
+ "istio": {
+ "type": {
+ "$ref": "#/273"
+ },
+ "flags": 0,
+ "description": "Istio service mesh configuration."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Istio"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioServiceMesh",
+ "properties": {
+ "components": {
+ "type": {
+ "$ref": "#/274"
+ },
+ "flags": 0,
+ "description": "Istio components configuration."
+ },
+ "certificateAuthority": {
+ "type": {
+ "$ref": "#/282"
+ },
+ "flags": 0,
+ "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca"
+ },
+ "revisions": {
+ "type": {
+ "$ref": "#/284"
+ },
+ "flags": 0,
+ "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioComponents",
+ "properties": {
+ "ingressGateways": {
+ "type": {
+ "$ref": "#/279"
+ },
+ "flags": 0,
+ "description": "Istio ingress gateways."
+ },
+ "egressGateways": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 0,
+ "description": "Istio egress gateways."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioIngressGateway",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/278"
+ },
+ "flags": 1,
+ "description": "Mode of an ingress gateway."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable the ingress gateway."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/277"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/275"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioEgressGateway",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Whether to enable the egress gateway."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/280"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioCertificateAuthority",
+ "properties": {
+ "plugin": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 0,
+ "description": "Plugin certificates information for Service Mesh."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioPluginCertificateAuthority",
+ "properties": {
+ "keyVaultId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the Key Vault."
+ },
+ "certObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate object name in Azure Key Vault."
+ },
+ "keyObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate private key object name in Azure Key Vault."
+ },
+ "rootCertObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Root certificate object name in Azure Key Vault."
+ },
+ "certChainObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Certificate chain object name in Azure Key Vault."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterMetricsProfile",
+ "properties": {
+ "costAnalysis": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 0,
+ "description": "The cost analysis configuration for the cluster"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterCostAnalysis",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterBootstrapProfile",
+ "properties": {
+ "artifactSource": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 0,
+ "description": "The source where the artifacts are downloaded from."
+ },
+ "containerRegistryId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cache"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Direct"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/288"
+ },
+ {
+ "$ref": "#/289"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/296"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/298"
+ },
+ {
+ "$ref": "#/299"
+ },
+ {
+ "$ref": "#/300"
+ },
+ {
+ "$ref": "#/301"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "Properties of a default maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceConfigurationProperties",
+ "properties": {
+ "timeInWeek": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries."
+ },
+ "notAllowedTime": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 0,
+ "description": "Time slots on which upgrade is not allowed."
+ },
+ "maintenanceWindow": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 0,
+ "description": "Maintenance window for the maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeInWeek",
+ "properties": {
+ "day": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 0,
+ "description": "The day of the week."
+ },
+ "hourSlots": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 0,
+ "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/309"
+ },
+ {
+ "$ref": "#/310"
+ },
+ {
+ "$ref": "#/311"
+ },
+ {
+ "$ref": "#/312"
+ },
+ {
+ "$ref": "#/313"
+ },
+ {
+ "$ref": "#/314"
+ },
+ {
+ "$ref": "#/315"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 23
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/317"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/308"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The start of a time span"
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end of a time span"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/320"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceWindow",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 1,
+ "description": "Recurrence schedule for the maintenance window."
+ },
+ "durationHours": {
+ "type": {
+ "$ref": "#/354"
+ },
+ "flags": 1,
+ "description": "Length of maintenance window range from 4 to 24 hours."
+ },
+ "utcOffset": {
+ "type": {
+ "$ref": "#/355"
+ },
+ "flags": 0,
+ "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 1,
+ "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'."
+ },
+ "notAllowedDates": {
+ "type": {
+ "$ref": "#/358"
+ },
+ "flags": 0,
+ "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Schedule",
+ "properties": {
+ "daily": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every day' or 'recur every 3 days'."
+ },
+ "weekly": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'."
+ },
+ "absoluteMonthly": {
+ "type": {
+ "$ref": "#/336"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'."
+ },
+ "relativeMonthly": {
+ "type": {
+ "$ref": "#/339"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DailySchedule",
+ "properties": {
+ "intervalDays": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 1,
+ "description": "Specifies the number of days between each set of occurrences."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 7
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WeeklySchedule",
+ "properties": {
+ "intervalWeeks": {
+ "type": {
+ "$ref": "#/327"
+ },
+ "flags": 1,
+ "description": "Specifies the number of weeks between each set of occurrences."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 4
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/329"
+ },
+ {
+ "$ref": "#/330"
+ },
+ {
+ "$ref": "#/331"
+ },
+ {
+ "$ref": "#/332"
+ },
+ {
+ "$ref": "#/333"
+ },
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AbsoluteMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "dayOfMonth": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 1,
+ "description": "The date of the month."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 6
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 31
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RelativeMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "weekIndex": {
+ "type": {
+ "$ref": "#/345"
+ },
+ "flags": 1,
+ "description": "Specifies on which week of the month the dayOfWeek applies."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/353"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/343"
+ },
+ {
+ "$ref": "#/344"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/347"
+ },
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ },
+ {
+ "$ref": "#/350"
+ },
+ {
+ "$ref": "#/351"
+ },
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 24
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^\\d{2}:\\d{2}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DateSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date of the date span."
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date of the date span."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/357"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/306"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 12,
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/362"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 0,
+ "description": "Properties of an agent pool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfileProperties",
+ "properties": {
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/382"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/385"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/388"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/391"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/392"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/398"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/399"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/400"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 0,
+ "description": "GPU settings for the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/366"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/371"
+ },
+ {
+ "$ref": "#/372"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/374"
+ },
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/377"
+ },
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/384"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/386"
+ },
+ {
+ "$ref": "#/387"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/389"
+ },
+ {
+ "$ref": "#/390"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/393"
+ },
+ {
+ "$ref": "#/394"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/396"
+ },
+ {
+ "$ref": "#/397"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/402"
+ },
+ {
+ "$ref": "#/403"
+ },
+ {
+ "$ref": "#/404"
+ },
+ {
+ "$ref": "#/405"
+ },
+ {
+ "$ref": "#/406"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/363"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/409"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/410"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/418"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 0,
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/420"
+ },
+ "flags": 1,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/413"
+ },
+ {
+ "$ref": "#/414"
+ },
+ {
+ "$ref": "#/415"
+ },
+ {
+ "$ref": "#/416"
+ },
+ {
+ "$ref": "#/417"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the private endpoint"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/425"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The private link service connection description."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/421"
+ },
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/424"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/411"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/snapshots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/snapshots",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/427"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/428"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 0,
+ "description": "Properties of a snapshot."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/442"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SnapshotProperties",
+ "properties": {
+ "creationData": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "type": {
+ "$ref": "#/432"
+ },
+ "flags": 0,
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of Kubernetes."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/435"
+ },
+ "flags": 2,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSku": {
+ "type": {
+ "$ref": "#/441"
+ },
+ "flags": 2,
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The size of the VM."
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 2,
+ "description": "Whether to use a FIPS-enabled OS."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodePool"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/436"
+ },
+ {
+ "$ref": "#/437"
+ },
+ {
+ "$ref": "#/438"
+ },
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/440"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/snapshots@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/429"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^([A-Za-z0-9-])+$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/448"
+ },
+ "flags": 1,
+ "description": "Properties for trusted access role binding"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrustedAccessRoleBindingProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of trusted access role binding."
+ },
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ARM resource ID of source resource that trusted access is configured for."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 1,
+ "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/449"
+ },
+ {
+ "$ref": "#/450"
+ },
+ {
+ "$ref": "#/451"
+ },
+ {
+ "$ref": "#/452"
+ },
+ {
+ "$ref": "#/453"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/447"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/meshRevisionProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/458"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 2,
+ "description": "Mesh revision profile properties for a mesh"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevisionProfileProperties",
+ "properties": {
+ "meshRevisions": {
+ "type": {
+ "$ref": "#/467"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevision",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/466"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CompatibleVersions",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The product/service name."
+ },
+ "versions": {
+ "type": {
+ "$ref": "#/465"
+ },
+ "flags": 0,
+ "description": "Product/service versions compatible with a service mesh add-on revision."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/464"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/462"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles@2025-02-01",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/460"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/469"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/470"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/472"
+ },
+ "flags": 2,
+ "description": "Mesh upgrade profile properties for a major.minor release."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshUpgradeProfileProperties",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/474"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/464"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/471"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools/machines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/476"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/477"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/478"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/480"
+ },
+ "flags": 2,
+ "description": "The properties of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineProperties",
+ "properties": {
+ "network": {
+ "type": {
+ "$ref": "#/481"
+ },
+ "flags": 2,
+ "description": "network properties of the machine"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Azure resource id of the machine. It can be used to GET underlying VM Instance"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineNetworkProperties",
+ "properties": {
+ "ipAddresses": {
+ "type": {
+ "$ref": "#/486"
+ },
+ "flags": 2,
+ "description": "IPv4, IPv6 addresses of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineIpAddress",
+ "properties": {
+ "family": {
+ "type": {
+ "$ref": "#/485"
+ },
+ "flags": 2,
+ "description": "To determine if address belongs IPv4 or IPv6 family"
+ },
+ "ip": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "IPv4 or IPv6 address of the machine"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/483"
+ },
+ {
+ "$ref": "#/484"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/482"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/479"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAccessProfile",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/489"
+ },
+ "flags": 0,
+ "description": "AccessProfile of a managed cluster."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/490"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessProfile",
+ "properties": {
+ "kubeConfig": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 0,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters/accessProfiles",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/488"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResults",
+ "properties": {
+ "kubeconfigs": {
+ "type": {
+ "$ref": "#/494"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResult",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/493"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterAdminCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/492"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/492"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterMonitoringUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/492"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetServicePrincipalProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetAADProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/205"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateClusterCertificates",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateServiceAccountSigningKeys",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stop",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandRequest",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The command to run."
+ },
+ "context": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64 encoded zip file containing the files required by the command."
+ },
+ "clusterToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AuthToken issued for AKS AAD Server App."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command id."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/507"
+ },
+ "flags": 0,
+ "description": "Properties of command result."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandResultProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "provisioning State"
+ },
+ "exitCode": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 2,
+ "description": "The exit code of the command"
+ },
+ "startedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command started."
+ },
+ "finishedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command finished."
+ },
+ "logs": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command output."
+ },
+ "reason": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "An explanation of why provisioningState is set to failed (if so)."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "runCommand",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/506"
+ },
+ "input": {
+ "$ref": "#/505"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resolvePrivateLinkServiceId",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/230"
+ },
+ "input": {
+ "$ref": "#/230"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters/agentPools",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolDeleteMachinesParameter",
+ "properties": {
+ "machineNames": {
+ "type": {
+ "$ref": "#/512"
+ },
+ "flags": 1,
+ "description": "The agent pool machine names."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deleteMachines",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/511"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "upgradeNodeImageVersion",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-02-01"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/containerservice/microsoft.containerservice/2025-02-02-preview/types.json b/internal/azure/generated/containerservice/microsoft.containerservice/2025-02-02-preview/types.json
new file mode 100644
index 000000000..1b740f4c6
--- /dev/null
+++ b/internal/azure/generated/containerservice/microsoft.containerservice/2025-02-02-preview/types.json
@@ -0,0 +1,9760 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The managed cluster SKU."
+ },
+ "extendedLocation": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 0,
+ "description": "The extended location of the Virtual Machine."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "The identity of the managed cluster, if configured."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "Properties of a managed cluster."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is primarily used to expose different UI experiences in the portal for different kinds"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSKU",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The name of a managed cluster SKU."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Base"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Automatic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Free"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExtendedLocation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EdgeZone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of the system assigned identity which is used by master components."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant id of the system assigned identity which is used by master components."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/20"
+ },
+ "flags": 0,
+ "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity)."
+ },
+ "delegatedResources": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 0,
+ "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResource",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ARM resource id of the delegated resource - internal use only."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "The tenant id of the delegated resource - internal use only."
+ },
+ "referralResource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The delegation id of the referral delegation (optional) - internal use only."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The source resource location - internal use only."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DelegatedResources",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/21"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/24"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "The Power State of the cluster."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot."
+ },
+ "maxAgentPools": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 2,
+ "description": "The max number of agent pools for the managed cluster."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details."
+ },
+ "currentKubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of Kubernetes the Managed Cluster is running."
+ },
+ "dnsPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdnSubdomain": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of the master pool."
+ },
+ "privateFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of private cluster."
+ },
+ "azurePortalFQDN": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly."
+ },
+ "agentPoolProfiles": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "The agent pool properties."
+ },
+ "linuxProfile": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 0,
+ "description": "The profile for Linux VMs in the Managed Cluster."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 0,
+ "description": "The profile for Windows VMs in the Managed Cluster."
+ },
+ "servicePrincipalProfile": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs."
+ },
+ "addonProfiles": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 0,
+ "description": "The profile of managed cluster add-on."
+ },
+ "podIdentityProfile": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 0,
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration."
+ },
+ "oidcIssuerProfile": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 0,
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "nodeResourceGroup": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the resource group containing agent pool nodes."
+ },
+ "nodeResourceGroupProfile": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 0,
+ "description": "The node resource group configuration profile."
+ },
+ "enableRBAC": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Kubernetes Role-Based Access Control."
+ },
+ "supportPlan": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 0,
+ "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'."
+ },
+ "enablePodSecurityPolicy": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp."
+ },
+ "enableNamespaceResources": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "The network configuration profile."
+ },
+ "aadProfile": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "The Azure Active Directory configuration."
+ },
+ "autoUpgradeProfile": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "The auto upgrade configuration."
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/273"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading a cluster."
+ },
+ "autoScalerProfile": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 0,
+ "description": "Parameters to be applied to the cluster-autoscaler when enabled"
+ },
+ "apiServerAccessProfile": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 0,
+ "description": "The access profile for managed cluster API server."
+ },
+ "diskEncryptionSetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'"
+ },
+ "identityProfile": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 0,
+ "description": "The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is \"kubeletidentity\", with value of \"resourceId\": \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}\"."
+ },
+ "privateLinkResources": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 0,
+ "description": "Private link resources associated with the cluster."
+ },
+ "disableLocalAccounts": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)."
+ },
+ "httpProxyConfig": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 0,
+ "description": "Configurations for provisioning the cluster with HTTP proxy servers."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 0,
+ "description": "Security profile for the managed cluster."
+ },
+ "storageProfile": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 0,
+ "description": "Storage profile for the managed cluster."
+ },
+ "ingressProfile": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "Ingress profile for the managed cluster."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 0,
+ "description": "Allow or deny public network access for AKS"
+ },
+ "workloadAutoScalerProfile": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 0,
+ "description": "Workload Auto-scaler profile for the managed cluster."
+ },
+ "azureMonitorProfile": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 0,
+ "description": "Prometheus addon profile for the container service cluster"
+ },
+ "safeguardsProfile": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 0,
+ "description": "The Safeguards profile holds all the safeguards information for a given cluster"
+ },
+ "serviceMeshProfile": {
+ "type": {
+ "$ref": "#/344"
+ },
+ "flags": 0,
+ "description": "Service mesh profile for a managed cluster."
+ },
+ "resourceUID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)"
+ },
+ "metricsProfile": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "Optional cluster metrics configuration."
+ },
+ "aiToolchainOperatorProfile": {
+ "type": {
+ "$ref": "#/363"
+ },
+ "flags": 0,
+ "description": "AI toolchain operator settings that apply to the whole cluster."
+ },
+ "nodeProvisioningProfile": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 0,
+ "description": "Node provisioning settings that apply to the whole cluster."
+ },
+ "bootstrapProfile": {
+ "type": {
+ "$ref": "#/368"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster bootstrap configuration."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/372"
+ },
+ "flags": 0,
+ "description": "Contains read-only information about the Managed Cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PowerState",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Tells whether the cluster is Running or Stopped"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/29"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreationData",
+ "properties": {
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is the ARM ID of the source object to be used to create the target object."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfile",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 1,
+ "description": "Windows agent pool names must be 6 characters or less."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/38"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/41"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podIPAllocationMode": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'."
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/67"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/78"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "enableCustomCATrust": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/84"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "nodeInitializationTaints": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`"
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The GPU settings of an agent pool."
+ },
+ "artifactStreamingProfile": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "Configuration for using artifact streaming on AKS."
+ },
+ "virtualMachinesProfile": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Specifications on VirtualMachines agent pool."
+ },
+ "virtualMachineNodesStatus": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 0,
+ "description": "The status of nodes in a VirtualMachines agent pool."
+ },
+ "gatewayProfile": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 0,
+ "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "Contains read-only information about the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 2048
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KataMshvVmIsolation"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DynamicIndividual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StaticBlock"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/52"
+ },
+ {
+ "$ref": "#/53"
+ },
+ {
+ "$ref": "#/54"
+ },
+ {
+ "$ref": "#/55"
+ },
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachines"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Gateway"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolUpgradeSettings",
+ "properties": {
+ "maxSurge": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster"
+ },
+ "maxUnavailable": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster"
+ },
+ "maxBlockedNodes": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is maxSurge. This must always be greater than or equal to maxSurge. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster"
+ },
+ "drainTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes."
+ },
+ "nodeSoakDurationInMinutes": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 0,
+ "description": "The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes."
+ },
+ "undrainableNodeBehavior": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 1440
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 30
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cordon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Schedule"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubeletConfig",
+ "properties": {
+ "cpuManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'."
+ },
+ "cpuCfsQuota": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "cpuCfsQuotaPeriod": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'."
+ },
+ "imageGcHighThreshold": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "To disable image garbage collection, set to 100. The default is 85%"
+ },
+ "imageGcLowThreshold": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%"
+ },
+ "topologyManagerPolicy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'."
+ },
+ "allowedUnsafeSysctls": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)."
+ },
+ "failSwapOn": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node."
+ },
+ "containerLogMaxSizeMB": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated."
+ },
+ "containerLogMaxFiles": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 0,
+ "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2."
+ },
+ "podMaxPids": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of processes per pod."
+ },
+ "seccompDefault": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "Specifies the default seccomp profile applied to all workloads. If not specified, 'Unconfined' will be used by default."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 2
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unconfined"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RuntimeDefault"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/92"
+ },
+ {
+ "$ref": "#/93"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LinuxOSConfig",
+ "properties": {
+ "sysctls": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 0,
+ "description": "Sysctl settings for Linux agent nodes."
+ },
+ "transparentHugePageEnabled": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "transparentHugePageDefrag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "swapFileSizeMB": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The size in MB of a swap file that will be created on each node."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SysctlConfig",
+ "properties": {
+ "netCoreSomaxconn": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.somaxconn."
+ },
+ "netCoreNetdevMaxBacklog": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.netdev_max_backlog."
+ },
+ "netCoreRmemDefault": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_default."
+ },
+ "netCoreRmemMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.rmem_max."
+ },
+ "netCoreWmemDefault": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_default."
+ },
+ "netCoreWmemMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.wmem_max."
+ },
+ "netCoreOptmemMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.core.optmem_max."
+ },
+ "netIpv4TcpMaxSynBacklog": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog."
+ },
+ "netIpv4TcpMaxTwBuckets": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets."
+ },
+ "netIpv4TcpFinTimeout": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_fin_timeout."
+ },
+ "netIpv4TcpKeepaliveTime": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_time."
+ },
+ "netIpv4TcpKeepaliveProbes": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_probes."
+ },
+ "netIpv4TcpkeepaliveIntvl": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl."
+ },
+ "netIpv4TcpTwReuse": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.tcp_tw_reuse."
+ },
+ "netIpv4IpLocalPortRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.ip_local_port_range."
+ },
+ "netIpv4NeighDefaultGcThresh1": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1."
+ },
+ "netIpv4NeighDefaultGcThresh2": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2."
+ },
+ "netIpv4NeighDefaultGcThresh3": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3."
+ },
+ "netNetfilterNfConntrackMax": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_max."
+ },
+ "netNetfilterNfConntrackBuckets": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "Sysctl setting net.netfilter.nf_conntrack_buckets."
+ },
+ "fsInotifyMaxUserWatches": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.inotify.max_user_watches."
+ },
+ "fsFileMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.file-max."
+ },
+ "fsAioMaxNr": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.aio-max-nr."
+ },
+ "fsNrOpen": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting fs.nr_open."
+ },
+ "kernelThreadsMax": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting kernel.threads-max."
+ },
+ "vmMaxMapCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.max_map_count."
+ },
+ "vmSwappiness": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.swappiness."
+ },
+ "vmVfsCachePressure": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Sysctl setting vm.vfs_cache_pressure."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 10,
+ "maxValue": 90
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 131072,
+ "maxValue": 2097152
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 65536,
+ "maxValue": 524288
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolWindowsProfile",
+ "properties": {
+ "disableOutboundNat": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolNetworkProfile",
+ "properties": {
+ "nodePublicIPTags": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "IPTags of instance-level public IPs."
+ },
+ "allowedHostPorts": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap."
+ },
+ "applicationSecurityGroups": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "The IDs of the application security groups which agent pool will associate when created."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IPTag",
+ "properties": {
+ "ipTagType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The IP tag type. Example: RoutingPreference."
+ },
+ "tag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The value of the IP tag associated with the public IP. Example: Internet."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/108"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PortRange",
+ "properties": {
+ "portStart": {
+ "type": {
+ "$ref": "#/111"
+ },
+ "flags": 0,
+ "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd."
+ },
+ "portEnd": {
+ "type": {
+ "$ref": "#/111"
+ },
+ "flags": 0,
+ "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart."
+ },
+ "protocol": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "The network protocol of the port."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 65535
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TCP"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UDP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/110"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolSecurityProfile",
+ "properties": {
+ "sshAccess": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 0,
+ "description": "SSH access method of an agent pool."
+ },
+ "enableVTPM": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ },
+ "enableSecureBoot": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LocalUser"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolGPUProfile",
+ "properties": {
+ "installGPUDriver": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The default value is true when the vmSize of the agent pool contains a GPU, false otherwise. GPU Driver Installation can only be set true when VM has an associated GPU resource. Setting this field to false prevents automatic GPU driver installation. In that case, in order for the GPU to be usable, the user must perform GPU driver installation themselves."
+ },
+ "driverType": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "Specify the type of GPU driver to install when creating Windows agent pools. If not provided, AKS selects the driver based on system compatibility. This cannot be changed once the AgentPool has been created. This cannot be set on Linux AgentPools. For Linux AgentPools, the driver is selected based on system compatibility."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GRID"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CUDA"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolArtifactStreamingProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachinesProfile",
+ "properties": {
+ "scale": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 0,
+ "description": "Specifications on how to scale a VirtualMachines agent pool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScaleProfile",
+ "properties": {
+ "manual": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 0,
+ "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size."
+ },
+ "autoscale": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 0,
+ "description": "Specifications on how to auto-scale the VirtualMachines agent pool within a predefined size range."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManualScaleProfile",
+ "properties": {
+ "size": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of nodes."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/128"
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualMachineNodes",
+ "properties": {
+ "size": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The VM size of the agents used to host this group of nodes."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of nodes."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/131"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolGatewayProfile",
+ "properties": {
+ "publicIPPrefixSize": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 28,
+ "maxValue": 31
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolStatus",
+ "properties": {
+ "provisioningError": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 2,
+ "description": "Preserves the detailed info of failure. If there was no error, this field is omitted."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CloudErrorBody",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/137"
+ },
+ "flags": 0,
+ "description": "A list of additional details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/136"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/33"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceLinuxProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 1,
+ "description": "The administrator username to use for Linux VMs."
+ },
+ "ssh": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 1,
+ "description": "The SSH configuration for Linux-based VMs running on Azure."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshConfiguration",
+ "properties": {
+ "publicKeys": {
+ "type": {
+ "$ref": "#/143"
+ },
+ "flags": 1,
+ "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceSshPublicKey",
+ "properties": {
+ "keyData": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/142"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWindowsProfile",
+ "properties": {
+ "adminUsername": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Specifies the name of the administrator account.
**Max-length:** 20 characters"
+ },
+ "adminPassword": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the password of the administrator account.
**Minimum-length:** 8 characters
**Max-length:** 123 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\""
+ },
+ "licenseType": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details."
+ },
+ "enableCSIProxy": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)."
+ },
+ "gmsaProfile": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The Windows gMSA Profile in the Managed Cluster."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows_Server"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WindowsGmsaProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Specifies whether to enable Windows gMSA in the managed cluster."
+ },
+ "dnsServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the DNS server for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ },
+ "rootDomainName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the root domain name for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterServicePrincipalProfile",
+ "properties": {
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ID for the service principal."
+ },
+ "secret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The secret password associated with the service principal in plain text."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether the add-on is enabled or not."
+ },
+ "config": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 0,
+ "description": "Key-value pairs for configuring an add-on."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 2,
+ "description": "Information of user assigned identity used by this add-on."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileConfig",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAddonProfileIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAddonProfiles",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/150"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether the pod identity addon is enabled."
+ },
+ "allowNetworkPluginKubenet": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "The pod identities to use in the cluster."
+ },
+ "userAssignedIdentityExceptions": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 0,
+ "description": "The pod identity exceptions to allow."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentity",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity."
+ },
+ "bindingSelector": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The binding selector to use for the AzureIdentityBinding resource."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 1,
+ "description": "The user assigned identity details."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of the pod identity."
+ },
+ "provisioningInfo": {
+ "type": {
+ "$ref": "#/164"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The object ID of the user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Assigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/159"
+ },
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/162"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningInfo",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "Pod identity assignment error (if any)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 0,
+ "description": "Details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityProvisioningErrorBody",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/167"
+ },
+ "flags": 0,
+ "description": "A list of additional details about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/166"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/155"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityException",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the pod identity exception."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The namespace of the pod identity exception."
+ },
+ "podLabels": {
+ "type": {
+ "$ref": "#/170"
+ },
+ "flags": 1,
+ "description": "The pod labels to match."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPodIdentityExceptionPodLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/169"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterOidcIssuerProfile",
+ "properties": {
+ "issuerURL": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The OIDC issuer url of the Managed Cluster."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether the OIDC issuer is enabled."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNodeResourceGroupProfile",
+ "properties": {
+ "restrictionLevel": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "The restriction level applied to the cluster's node resource group"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unrestricted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReadOnly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesOfficial"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AKSLongTermSupport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfile",
+ "properties": {
+ "networkPlugin": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "networkPluginMode": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 0,
+ "description": "Network plugin mode used for building the Kubernetes network."
+ },
+ "networkPolicy": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "networkMode": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "networkDataplane": {
+ "type": {
+ "$ref": "#/197"
+ },
+ "flags": 0,
+ "description": "Network dataplane used in the Kubernetes cluster."
+ },
+ "podCidr": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used."
+ },
+ "serviceCidr": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 0,
+ "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges."
+ },
+ "dnsServiceIP": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr."
+ },
+ "outboundType": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 0,
+ "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)."
+ },
+ "loadBalancerSku": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "loadBalancerProfile": {
+ "type": {
+ "$ref": "#/209"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster load balancer."
+ },
+ "natGatewayProfile": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "Profile of the cluster NAT gateway."
+ },
+ "staticEgressGatewayProfile": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway."
+ },
+ "podCidrs": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking."
+ },
+ "serviceCidrs": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 0,
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges."
+ },
+ "ipFamilies": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6."
+ },
+ "podLinkLocalAccess": {
+ "type": {
+ "$ref": "#/240"
+ },
+ "flags": 0,
+ "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'."
+ },
+ "kubeProxyConfig": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 0,
+ "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'."
+ },
+ "advancedNetworking": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "kubenet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/181"
+ },
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "overlay"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/185"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "calico"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/187"
+ },
+ {
+ "$ref": "#/188"
+ },
+ {
+ "$ref": "#/189"
+ },
+ {
+ "$ref": "#/190"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "transparent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "bridge"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/195"
+ },
+ {
+ "$ref": "#/196"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "loadBalancer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userDefinedRouting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "managedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "userAssignedNATGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/200"
+ },
+ {
+ "$ref": "#/201"
+ },
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/203"
+ },
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/206"
+ },
+ {
+ "$ref": "#/207"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfile",
+ "properties": {
+ "managedOutboundIPs": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 0,
+ "description": "Desired managed outbound IPs for the cluster load balancer."
+ },
+ "outboundIPPrefixes": {
+ "type": {
+ "$ref": "#/213"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP Prefix resources for the cluster load balancer."
+ },
+ "outboundIPs": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 0,
+ "description": "Desired outbound IP resources for the cluster load balancer."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster load balancer."
+ },
+ "allocatedOutboundPorts": {
+ "type": {
+ "$ref": "#/219"
+ },
+ "flags": 0,
+ "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes."
+ },
+ "enableMultipleStandardLoadBalancers": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Enable multiple standard load balancers per AKS cluster or not."
+ },
+ "backendPoolType": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "The type of the managed inbound Load Balancer BackendPool."
+ },
+ "clusterServiceLoadBalancerHealthProbeMode": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "The health probing behavior for External Traffic Policy Cluster services."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileManagedOutboundIPs",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1."
+ },
+ "countIPv6": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 100
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 100
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPPrefixes",
+ "properties": {
+ "publicIPPrefixes": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "A list of public IP prefix resources."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceReference",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The fully qualified Azure resource id."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/214"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterLoadBalancerProfileOutboundIPs",
+ "properties": {
+ "publicIPs": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "A list of public IP resources."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/214"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/214"
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 64000
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 120
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIPConfiguration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeIP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/221"
+ },
+ {
+ "$ref": "#/222"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ServiceNodePort"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Shared"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNATGatewayProfile",
+ "properties": {
+ "managedOutboundIPProfile": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "Profile of the managed outbound IP resources of the cluster NAT gateway."
+ },
+ "effectiveOutboundIPs": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 2,
+ "description": "The effective outbound IP resources of the cluster NAT gateway."
+ },
+ "idleTimeoutInMinutes": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 0,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterManagedOutboundIPProfile",
+ "properties": {
+ "count": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 16
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/214"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStaticEgressGatewayProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Static Egress Gateway addon is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/234"
+ },
+ {
+ "$ref": "#/235"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/236"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IMDS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/238"
+ },
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfileKubeProxyConfig",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 0,
+ "description": "Specify which proxy mode to use ('IPTABLES' or 'IPVS')"
+ },
+ "ipvsConfig": {
+ "type": {
+ "$ref": "#/245"
+ },
+ "flags": 0,
+ "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPTABLES"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPVS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/243"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerServiceNetworkProfileKubeProxyConfigIpvsConfig",
+ "properties": {
+ "scheduler": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html."
+ },
+ "tcpTimeoutSeconds": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value."
+ },
+ "tcpFinTimeoutSeconds": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value."
+ },
+ "udpTimeoutSeconds": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RoundRobin"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LeastConnection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworking",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false."
+ },
+ "observability": {
+ "type": {
+ "$ref": "#/250"
+ },
+ "flags": 0,
+ "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts."
+ },
+ "security": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 0,
+ "description": "Security profile to enable security features on cilium-based cluster."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingObservability",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdvancedNetworkingSecurity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Configure Advanced Networking Security features on Cilium clusters. See individual fields for their default values."
+ },
+ "advancedNetworkPolicies": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 0,
+ "description": "This allows users to configure Layer 7 network policies (FQDN, HTTP, Kafka). Policies themselves must be configured via the Cilium Network Policy resources, see https://docs.cilium.io/en/latest/security/policy/index.html. This can be enabled only on cilium-based clusters. If not specified, the default value is FQDN if security.enabled is set to true."
+ },
+ "transitEncryption": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 0,
+ "description": "This can be enabled only on Cilium-based clusters. If not specified, the default value is None."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "L7"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FQDN"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/252"
+ },
+ {
+ "$ref": "#/253"
+ },
+ {
+ "$ref": "#/254"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WireGuard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/257"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAADProfile",
+ "properties": {
+ "managed": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable managed AAD."
+ },
+ "enableAzureRBAC": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure RBAC for Kubernetes authorization."
+ },
+ "adminGroupObjectIDs": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 0,
+ "description": "The list of AAD group object IDs that will have admin role of the cluster."
+ },
+ "clientAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "serverAppSecret": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy."
+ },
+ "tenantID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAutoUpgradeProfile",
+ "properties": {
+ "upgradeChannel": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 0,
+ "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)."
+ },
+ "nodeOSUpgradeChannel": {
+ "type": {
+ "$ref": "#/272"
+ },
+ "flags": 0,
+ "description": "The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "rapid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "stable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "patch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "node-image"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/262"
+ },
+ {
+ "$ref": "#/263"
+ },
+ {
+ "$ref": "#/264"
+ },
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unmanaged"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecurityPatch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeImage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/269"
+ },
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterUpgradeSettings",
+ "properties": {
+ "overrideSettings": {
+ "type": {
+ "$ref": "#/274"
+ },
+ "flags": 0,
+ "description": "Settings for overrides."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpgradeOverrideSettings",
+ "properties": {
+ "forceUpgrade": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution."
+ },
+ "until": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesAutoScalerProfile",
+ "properties": {
+ "balance-similar-node-groups": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Valid values are 'true' and 'false'"
+ },
+ "daemonset-eviction-for-empty-nodes": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "daemonset-eviction-for-occupied-nodes": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted."
+ },
+ "ignore-daemonsets-utilization": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "If set to true, the resources used by daemonset will be taken into account when making scaling down decisions."
+ },
+ "expander": {
+ "type": {
+ "$ref": "#/280"
+ },
+ "flags": 0,
+ "description": "Available values are: 'least-waste', 'most-pods', 'priority', 'random'."
+ },
+ "max-empty-bulk-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 10."
+ },
+ "max-graceful-termination-sec": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 600."
+ },
+ "max-node-provision-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "max-total-unready-percentage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is 45. The maximum is 100 and the minimum is 0."
+ },
+ "new-pod-scale-up-delay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)."
+ },
+ "ok-total-unready-count": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This must be an integer. The default is 3."
+ },
+ "scan-interval": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10'. Values must be an integer number of seconds."
+ },
+ "scale-down-delay-after-add": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-delete": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-failure": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unneeded-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unready-time": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-utilization-threshold": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is '0.5'."
+ },
+ "skip-nodes-with-local-storage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ },
+ "skip-nodes-with-system-pods": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is true."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "least-waste"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "most-pods"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "priority"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "random"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/277"
+ },
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAPIServerAccessProfile",
+ "properties": {
+ "authorizedIPRanges": {
+ "type": {
+ "$ref": "#/282"
+ },
+ "flags": 0,
+ "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)."
+ },
+ "enablePrivateCluster": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)."
+ },
+ "privateDNSZone": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'."
+ },
+ "enablePrivateClusterPublicFQDN": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to create additional public FQDN for private cluster or not."
+ },
+ "disableRunCommand": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to disable run command for the cluster or not."
+ },
+ "enableVnetIntegration": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable apiserver vnet integration for the cluster or not."
+ },
+ "subnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesIdentityProfile",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/156"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the private link resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the private link resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource type."
+ },
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The group ID of the resource."
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 0,
+ "description": "The RequiredMembers of the resource"
+ },
+ "privateLinkServiceID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The private link service ID of the resource, this field is exposed only to NRP internally."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/284"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterHttpProxyConfig",
+ "properties": {
+ "httpProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTP proxy server endpoint to use."
+ },
+ "httpsProxy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The HTTPS proxy server endpoint to use."
+ },
+ "noProxy": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 0,
+ "description": "The endpoints that should not go through proxy."
+ },
+ "effectiveNoProxy": {
+ "type": {
+ "$ref": "#/289"
+ },
+ "flags": 2,
+ "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS."
+ },
+ "trustedCa": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Alternative CA cert to use for connecting to proxy servers."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfile",
+ "properties": {
+ "defender": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "azureKeyVaultKms": {
+ "type": {
+ "$ref": "#/296"
+ },
+ "flags": 0,
+ "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile."
+ },
+ "workloadIdentity": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 0,
+ "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details."
+ },
+ "imageCleaner": {
+ "type": {
+ "$ref": "#/301"
+ },
+ "flags": 0,
+ "description": "Image Cleaner settings for the security profile."
+ },
+ "imageIntegrity": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 0,
+ "description": "Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy."
+ },
+ "nodeRestriction": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 0,
+ "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile."
+ },
+ "customCATrustCertificates": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 0,
+ "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefender",
+ "properties": {
+ "logAnalyticsWorkspaceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty."
+ },
+ "securityMonitoring": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender threat detection for Cloud settings for the security profile."
+ },
+ "securityGating": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "Microsoft Defender settings for security gating, validates container images eligibility for deployment based on Defender for Containers security findings. Using Admission Controller, it either audits or prevents the deployment of images that do not meet security standards."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityMonitoring",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Defender threat detection"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityGating",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Defender security gating. When enabled, the gating feature will scan container images and audit or block the deployment of images that do not meet security standards according to the configured security rules."
+ },
+ "identities": {
+ "type": {
+ "$ref": "#/295"
+ },
+ "flags": 0,
+ "description": "List of identities that the admission controller will make use of in order to pull security artifacts from the registry. These are the same identities used by the cluster to pull container images. Each identity provided should have federated identity credential attached to it."
+ },
+ "allowSecretAccess": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "In use only while registry access granted by secret rather than managed identity. Set whether to grant the Defender gating agent access to the cluster's secrets for pulling images from registries. If secret access is denied and the registry requires pull secrets, the add-on will not perform any image validation. Default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileDefenderSecurityGatingIdentitiesItem",
+ "properties": {
+ "azureContainerRegistry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The container registry for which the identity will be used; the identity specified here should have a federated identity credential attached to it."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 0,
+ "description": "The identity object used to access the registry"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/294"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureKeyVaultKms",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Azure Key Vault key management service. The default is false."
+ },
+ "keyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
+ },
+ "keyVaultNetworkAccess": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 0,
+ "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`."
+ },
+ "keyVaultResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Public"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Private"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/297"
+ },
+ {
+ "$ref": "#/298"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileWorkloadIdentity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable workload identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileImageCleaner",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Image Cleaner on AKS cluster."
+ },
+ "intervalHours": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Image Cleaner scanning interval in hours."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileImageIntegrity",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable image integrity. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSecurityProfileNodeRestriction",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Node Restriction"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/130"
+ },
+ "maxLength": 10
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfile",
+ "properties": {
+ "diskCSIDriver": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 0,
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "fileCSIDriver": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "snapshotController": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 0,
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "blobCSIDriver": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileDiskCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureDisk CSI Driver. The default value is true."
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of AzureDisk CSI Driver. The default value is v1."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileFileCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureFile CSI Driver. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileSnapshotController",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Snapshot Controller. The default value is true."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStorageProfileBlobCSIDriver",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable AzureBlob CSI Driver. The default value is false."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfile",
+ "properties": {
+ "webAppRouting": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 0,
+ "description": "Web App Routing settings for the ingress profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileWebAppRouting",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable Web App Routing."
+ },
+ "dnsZoneResourceIds": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 0,
+ "description": "Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group."
+ },
+ "nginx": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "Configuration for the default NginxIngressController. See more at https://learn.microsoft.com/en-us/azure/aks/app-routing-nginx-configuration#the-default-nginx-ingress-controller."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 2,
+ "description": "Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 5
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterIngressProfileNginx",
+ "properties": {
+ "defaultIngressControllerType": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 0,
+ "description": "Ingress type for the default NginxIngressController custom resource"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AnnotationControlled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/314"
+ },
+ {
+ "$ref": "#/315"
+ },
+ {
+ "$ref": "#/316"
+ },
+ {
+ "$ref": "#/317"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecuredByPerimeter"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/319"
+ },
+ {
+ "$ref": "#/320"
+ },
+ {
+ "$ref": "#/321"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfile",
+ "properties": {
+ "keda": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 0,
+ "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile."
+ },
+ "verticalPodAutoscaler": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileKeda",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable KEDA."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable VPA add-on in cluster. Default value is false."
+ },
+ "addonAutoscaling": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 0,
+ "description": "Whether VPA add-on is enabled and configured to scale AKS-managed add-ons."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/326"
+ },
+ {
+ "$ref": "#/327"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfile",
+ "properties": {
+ "metrics": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 0,
+ "description": "Metrics profile for the prometheus service addon"
+ },
+ "containerInsights": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 0,
+ "description": "Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview."
+ },
+ "appMonitoring": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileMetrics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable the Prometheus collector"
+ },
+ "kubeStateMetrics": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 0,
+ "description": "Kube State Metrics for prometheus addon profile for the container service cluster"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileKubeStateMetrics",
+ "properties": {
+ "metricLabelsAllowlist": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of Kubernetes annotations keys that will be used in the resource's labels metric."
+ },
+ "metricAnnotationsAllowList": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileContainerInsights",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Azure Monitor Container Insights Logs Addon is enabled or not."
+ },
+ "logAnalyticsWorkspaceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs."
+ },
+ "syslogPort": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The syslog host port. If not specified, the default port is 28330."
+ },
+ "disableCustomMetrics": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false"
+ },
+ "disablePrometheusMetricsScraping": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoring",
+ "properties": {
+ "autoInstrumentation": {
+ "type": {
+ "$ref": "#/334"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ },
+ "openTelemetryMetrics": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ },
+ "openTelemetryLogs": {
+ "type": {
+ "$ref": "#/336"
+ },
+ "flags": 0,
+ "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Application Monitoring Auto Instrumentation is enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Application Monitoring Open Telemetry Metrics is enabled or not."
+ },
+ "port": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not."
+ },
+ "port": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SafeguardsProfile",
+ "properties": {
+ "systemExcludedNamespaces": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 2,
+ "description": "List of namespaces specified by AKS to be excluded from Safeguards"
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of constraints to use"
+ },
+ "level": {
+ "type": {
+ "$ref": "#/342"
+ },
+ "flags": 1,
+ "description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces"
+ },
+ "excludedNamespaces": {
+ "type": {
+ "$ref": "#/343"
+ },
+ "flags": 0,
+ "description": "List of namespaces excluded from Safeguards checks"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Off"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enforcement"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServiceMeshProfile",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 1,
+ "description": "Mode of the service mesh."
+ },
+ "istio": {
+ "type": {
+ "$ref": "#/348"
+ },
+ "flags": 0,
+ "description": "Istio service mesh configuration."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Istio"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/345"
+ },
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioServiceMesh",
+ "properties": {
+ "components": {
+ "type": {
+ "$ref": "#/349"
+ },
+ "flags": 0,
+ "description": "Istio components configuration."
+ },
+ "certificateAuthority": {
+ "type": {
+ "$ref": "#/358"
+ },
+ "flags": 0,
+ "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca"
+ },
+ "revisions": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 0,
+ "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioComponents",
+ "properties": {
+ "ingressGateways": {
+ "type": {
+ "$ref": "#/354"
+ },
+ "flags": 0,
+ "description": "Istio ingress gateways."
+ },
+ "egressGateways": {
+ "type": {
+ "$ref": "#/357"
+ },
+ "flags": 0,
+ "description": "Istio egress gateways."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioIngressGateway",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/353"
+ },
+ "flags": 1,
+ "description": "Mode of an ingress gateway."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable the ingress gateway."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "External"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Internal"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/351"
+ },
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/350"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioEgressGateway",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "Whether to enable the egress gateway."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 1,
+ "description": "Name of the Istio add-on egress gateway."
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Namespace that the Istio add-on egress gateway should be deployed in. If unspecified, the default is aks-istio-egress."
+ },
+ "gatewayConfigurationName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the gateway configuration custom resource for the Istio add-on egress gateway. Must be specified when enabling the Istio egress gateway. Must be deployed in the same namespace that the Istio egress gateway will be deployed in."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/355"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioCertificateAuthority",
+ "properties": {
+ "plugin": {
+ "type": {
+ "$ref": "#/359"
+ },
+ "flags": 0,
+ "description": "Plugin certificates information for Service Mesh."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IstioPluginCertificateAuthority",
+ "properties": {
+ "keyVaultId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the Key Vault."
+ },
+ "certObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate object name in Azure Key Vault."
+ },
+ "keyObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Intermediate certificate private key object name in Azure Key Vault."
+ },
+ "rootCertObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Root certificate object name in Azure Key Vault."
+ },
+ "certChainObjectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Certificate chain object name in Azure Key Vault."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterMetricsProfile",
+ "properties": {
+ "costAnalysis": {
+ "type": {
+ "$ref": "#/362"
+ },
+ "flags": 0,
+ "description": "The cost analysis configuration for the cluster"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterCostAnalysis",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAIToolchainOperatorProfile",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Indicates if AI toolchain operator enabled or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterNodeProvisioningProfile",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 0,
+ "description": "Once the mode it set to Auto, it cannot be changed back to Manual."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Manual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Auto"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/366"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterBootstrapProfile",
+ "properties": {
+ "artifactSource": {
+ "type": {
+ "$ref": "#/371"
+ },
+ "flags": 0,
+ "description": "The source where the artifacts are downloaded from."
+ },
+ "containerRegistryId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cache"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Direct"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/370"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterStatus",
+ "properties": {
+ "provisioningError": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 2,
+ "description": "Preserves the detailed info of failure. If there was no error, this field is omitted."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/379"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/384"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/376"
+ },
+ {
+ "$ref": "#/377"
+ },
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/382"
+ },
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/386"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/387"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/389"
+ },
+ "flags": 0,
+ "description": "Properties of a default maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceConfigurationProperties",
+ "properties": {
+ "timeInWeek": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries."
+ },
+ "notAllowedTime": {
+ "type": {
+ "$ref": "#/403"
+ },
+ "flags": 0,
+ "description": "Time slots on which upgrade is not allowed."
+ },
+ "maintenanceWindow": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 0,
+ "description": "Maintenance window for the maintenance configuration."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeInWeek",
+ "properties": {
+ "day": {
+ "type": {
+ "$ref": "#/398"
+ },
+ "flags": 0,
+ "description": "The day of the week."
+ },
+ "hourSlots": {
+ "type": {
+ "$ref": "#/400"
+ },
+ "flags": 0,
+ "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/391"
+ },
+ {
+ "$ref": "#/392"
+ },
+ {
+ "$ref": "#/393"
+ },
+ {
+ "$ref": "#/394"
+ },
+ {
+ "$ref": "#/395"
+ },
+ {
+ "$ref": "#/396"
+ },
+ {
+ "$ref": "#/397"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 23
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/399"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/390"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TimeSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The start of a time span"
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end of a time span"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/402"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaintenanceWindow",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/405"
+ },
+ "flags": 1,
+ "description": "Recurrence schedule for the maintenance window."
+ },
+ "durationHours": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 1,
+ "description": "Length of maintenance window range from 4 to 24 hours."
+ },
+ "utcOffset": {
+ "type": {
+ "$ref": "#/437"
+ },
+ "flags": 0,
+ "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/438"
+ },
+ "flags": 1,
+ "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'."
+ },
+ "notAllowedDates": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 0,
+ "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Schedule",
+ "properties": {
+ "daily": {
+ "type": {
+ "$ref": "#/406"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every day' or 'recur every 3 days'."
+ },
+ "weekly": {
+ "type": {
+ "$ref": "#/408"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'."
+ },
+ "absoluteMonthly": {
+ "type": {
+ "$ref": "#/418"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'."
+ },
+ "relativeMonthly": {
+ "type": {
+ "$ref": "#/421"
+ },
+ "flags": 0,
+ "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DailySchedule",
+ "properties": {
+ "intervalDays": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 1,
+ "description": "Specifies the number of days between each set of occurrences."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 7
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WeeklySchedule",
+ "properties": {
+ "intervalWeeks": {
+ "type": {
+ "$ref": "#/409"
+ },
+ "flags": 1,
+ "description": "Specifies the number of weeks between each set of occurrences."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 4
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/410"
+ },
+ {
+ "$ref": "#/411"
+ },
+ {
+ "$ref": "#/412"
+ },
+ {
+ "$ref": "#/413"
+ },
+ {
+ "$ref": "#/414"
+ },
+ {
+ "$ref": "#/415"
+ },
+ {
+ "$ref": "#/416"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AbsoluteMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "dayOfMonth": {
+ "type": {
+ "$ref": "#/420"
+ },
+ "flags": 1,
+ "description": "The date of the month."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 6
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 31
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RelativeMonthlySchedule",
+ "properties": {
+ "intervalMonths": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 1,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "weekIndex": {
+ "type": {
+ "$ref": "#/427"
+ },
+ "flags": 1,
+ "description": "Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs."
+ },
+ "dayOfWeek": {
+ "type": {
+ "$ref": "#/435"
+ },
+ "flags": 1,
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/424"
+ },
+ {
+ "$ref": "#/425"
+ },
+ {
+ "$ref": "#/426"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/429"
+ },
+ {
+ "$ref": "#/430"
+ },
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 4,
+ "maxValue": 24
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$"
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^\\d{2}:\\d{2}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DateSpan",
+ "properties": {
+ "start": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date of the date span."
+ },
+ "end": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date of the date span."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/439"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/388"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/namespaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/namespaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/442"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/443"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the managed cluster namespace."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the namespace."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/447"
+ },
+ "flags": 0,
+ "description": "Properties of a namespace."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NamespaceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NamespaceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of the namespace."
+ },
+ "labels": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 0,
+ "description": "The labels of managed namespace."
+ },
+ "annotations": {
+ "type": {
+ "$ref": "#/456"
+ },
+ "flags": 0,
+ "description": "The annotations of managed namespace."
+ },
+ "defaultResourceQuota": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 0,
+ "description": "The default resource quota enforced upon the namespace. Customers can have other Kubernetes resource quota objects under the namespace. All the resource quotas will be enforced."
+ },
+ "defaultNetworkPolicy": {
+ "type": {
+ "$ref": "#/458"
+ },
+ "flags": 0,
+ "description": "The default network policy enforced upon the namespace. Customers can have other Kubernetes network policy objects under the namespace. All the network policies will be enforced."
+ },
+ "adoptionPolicy": {
+ "type": {
+ "$ref": "#/470"
+ },
+ "flags": 0,
+ "description": "Action if Kubernetes namespace with same name already exists."
+ },
+ "deletePolicy": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 0,
+ "description": "Delete options of a namespace."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/448"
+ },
+ {
+ "$ref": "#/449"
+ },
+ {
+ "$ref": "#/450"
+ },
+ {
+ "$ref": "#/451"
+ },
+ {
+ "$ref": "#/452"
+ },
+ {
+ "$ref": "#/453"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NamespacePropertiesLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NamespacePropertiesAnnotations",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceQuota",
+ "properties": {
+ "cpuRequest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "CPU request of the namespace in one-thousandth CPU form. See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details."
+ },
+ "cpuLimit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "CPU limit of the namespace in one-thousandth CPU form. See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details."
+ },
+ "memoryRequest": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details."
+ },
+ "memoryLimit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkPolicies",
+ "properties": {
+ "ingress": {
+ "type": {
+ "$ref": "#/462"
+ },
+ "flags": 0,
+ "description": "Ingress policy for the network."
+ },
+ "egress": {
+ "type": {
+ "$ref": "#/466"
+ },
+ "flags": 0,
+ "description": "Egress policy for the network."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DenyAll"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllowAll"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllowSameNamespace"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/459"
+ },
+ {
+ "$ref": "#/460"
+ },
+ {
+ "$ref": "#/461"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DenyAll"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllowAll"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllowSameNamespace"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/463"
+ },
+ {
+ "$ref": "#/464"
+ },
+ {
+ "$ref": "#/465"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Never"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IfIdentical"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Always"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/467"
+ },
+ {
+ "$ref": "#/468"
+ },
+ {
+ "$ref": "#/469"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Keep"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/471"
+ },
+ {
+ "$ref": "#/472"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/namespaces@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/445"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 12,
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/475"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/476"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/477"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/479"
+ },
+ "flags": 0,
+ "description": "Properties of an agent pool."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfileProperties",
+ "properties": {
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention."
+ },
+ "count": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "osDiskType": {
+ "type": {
+ "$ref": "#/482"
+ },
+ "flags": 0,
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "kubeletDiskType": {
+ "type": {
+ "$ref": "#/485"
+ },
+ "flags": 0,
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "workloadRuntime": {
+ "type": {
+ "$ref": "#/489"
+ },
+ "flags": 0,
+ "description": "Determines the type of workload a node can run."
+ },
+ "messageOfTheDay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podIPAllocationMode": {
+ "type": {
+ "$ref": "#/492"
+ },
+ "flags": 0,
+ "description": "The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'."
+ },
+ "maxPods": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/495"
+ },
+ "flags": 0,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSKU": {
+ "type": {
+ "$ref": "#/503"
+ },
+ "flags": 0,
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "maxCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "type": {
+ "$ref": "#/506"
+ },
+ "flags": 0,
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/510"
+ },
+ "flags": 0,
+ "description": "The type of Agent Pool."
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/514"
+ },
+ "flags": 0,
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "orchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 0,
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/515"
+ },
+ "flags": 0,
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "enableCustomCATrust": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "type": {
+ "$ref": "#/521"
+ },
+ "flags": 0,
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/522"
+ },
+ "flags": 0,
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": {
+ "$ref": "#/523"
+ },
+ "flags": 0,
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": {
+ "$ref": "#/524"
+ },
+ "flags": 0,
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "nodeInitializationTaints": {
+ "type": {
+ "$ref": "#/525"
+ },
+ "flags": 0,
+ "description": "These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`"
+ },
+ "proximityPlacementGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 0,
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "type": {
+ "$ref": "#/531"
+ },
+ "flags": 0,
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "windowsProfile": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "The Windows agent pool's specific profile."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "Network-related settings of an agent pool."
+ },
+ "securityProfile": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "The security settings of an agent pool."
+ },
+ "gpuProfile": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The GPU settings of an agent pool."
+ },
+ "artifactStreamingProfile": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "Configuration for using artifact streaming on AKS."
+ },
+ "virtualMachinesProfile": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Specifications on VirtualMachines agent pool."
+ },
+ "virtualMachineNodesStatus": {
+ "type": {
+ "$ref": "#/532"
+ },
+ "flags": 0,
+ "description": "The status of nodes in a VirtualMachines agent pool."
+ },
+ "gatewayProfile": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 0,
+ "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "Contains read-only information about the Agent Pool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Managed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ephemeral"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/480"
+ },
+ {
+ "$ref": "#/481"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Temporary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/483"
+ },
+ {
+ "$ref": "#/484"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OCIContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WasmWasi"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KataMshvVmIsolation"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/486"
+ },
+ {
+ "$ref": "#/487"
+ },
+ {
+ "$ref": "#/488"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DynamicIndividual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StaticBlock"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/490"
+ },
+ {
+ "$ref": "#/491"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/493"
+ },
+ {
+ "$ref": "#/494"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/496"
+ },
+ {
+ "$ref": "#/497"
+ },
+ {
+ "$ref": "#/498"
+ },
+ {
+ "$ref": "#/499"
+ },
+ {
+ "$ref": "#/500"
+ },
+ {
+ "$ref": "#/501"
+ },
+ {
+ "$ref": "#/502"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/504"
+ },
+ {
+ "$ref": "#/505"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachineScaleSets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AvailabilitySet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VirtualMachines"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/507"
+ },
+ {
+ "$ref": "#/508"
+ },
+ {
+ "$ref": "#/509"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Gateway"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/511"
+ },
+ {
+ "$ref": "#/512"
+ },
+ {
+ "$ref": "#/513"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spot"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Regular"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/516"
+ },
+ {
+ "$ref": "#/517"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/519"
+ },
+ {
+ "$ref": "#/520"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAgentPoolProfilePropertiesNodeLabels",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG1g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG2g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG3g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG4g"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MIG7g"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/526"
+ },
+ {
+ "$ref": "#/527"
+ },
+ {
+ "$ref": "#/528"
+ },
+ {
+ "$ref": "#/529"
+ },
+ {
+ "$ref": "#/530"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/131"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/478"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/534"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/535"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/537"
+ },
+ "flags": 0,
+ "description": "The properties of a private endpoint connection."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/543"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ },
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/544"
+ },
+ "flags": 0,
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/545"
+ },
+ "flags": 1,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/538"
+ },
+ {
+ "$ref": "#/539"
+ },
+ {
+ "$ref": "#/540"
+ },
+ {
+ "$ref": "#/541"
+ },
+ {
+ "$ref": "#/542"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the private endpoint"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/550"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The private link service connection description."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/546"
+ },
+ {
+ "$ref": "#/547"
+ },
+ {
+ "$ref": "#/548"
+ },
+ {
+ "$ref": "#/549"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/536"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/snapshots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/snapshots",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/552"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/553"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/555"
+ },
+ "flags": 0,
+ "description": "Properties of a snapshot."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/570"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SnapshotProperties",
+ "properties": {
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "type": {
+ "$ref": "#/558"
+ },
+ "flags": 0,
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of Kubernetes."
+ },
+ "nodeImageVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The version of node image."
+ },
+ "osType": {
+ "type": {
+ "$ref": "#/561"
+ },
+ "flags": 2,
+ "description": "The operating system type. The default is Linux."
+ },
+ "osSku": {
+ "type": {
+ "$ref": "#/569"
+ },
+ "flags": 2,
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The size of the VM."
+ },
+ "enableFIPS": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2,
+ "description": "Whether to use a FIPS-enabled OS."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodePool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedCluster"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/556"
+ },
+ {
+ "$ref": "#/557"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Linux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/559"
+ },
+ {
+ "$ref": "#/560"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ubuntu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Mariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureLinux"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CBLMariner"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2019"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Windows2022"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/562"
+ },
+ {
+ "$ref": "#/563"
+ },
+ {
+ "$ref": "#/564"
+ },
+ {
+ "$ref": "#/565"
+ },
+ {
+ "$ref": "#/566"
+ },
+ {
+ "$ref": "#/567"
+ },
+ {
+ "$ref": "#/568"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/snapshots@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/554"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedclustersnapshots"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedclustersnapshots",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/572"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/573"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/575"
+ },
+ "flags": 0,
+ "description": "Properties of a managed cluster snapshot."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/598"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterSnapshotProperties",
+ "properties": {
+ "creationData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "CreationData to be used to specify the source resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "type": {
+ "$ref": "#/578"
+ },
+ "flags": 0,
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "managedClusterPropertiesReadOnly": {
+ "type": {
+ "$ref": "#/579"
+ },
+ "flags": 2,
+ "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodePool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedCluster"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/576"
+ },
+ {
+ "$ref": "#/577"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterPropertiesForSnapshot",
+ "properties": {
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The current kubernetes version."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The current managed cluster sku."
+ },
+ "enableRbac": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not."
+ },
+ "networkProfile": {
+ "type": {
+ "$ref": "#/580"
+ },
+ "flags": 2,
+ "description": "The current network profile."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkProfileForSnapshot",
+ "properties": {
+ "networkPlugin": {
+ "type": {
+ "$ref": "#/584"
+ },
+ "flags": 0,
+ "description": "networkPlugin for managed cluster snapshot."
+ },
+ "networkPluginMode": {
+ "type": {
+ "$ref": "#/586"
+ },
+ "flags": 0,
+ "description": "NetworkPluginMode for managed cluster snapshot."
+ },
+ "networkPolicy": {
+ "type": {
+ "$ref": "#/591"
+ },
+ "flags": 0,
+ "description": "networkPolicy for managed cluster snapshot."
+ },
+ "networkMode": {
+ "type": {
+ "$ref": "#/594"
+ },
+ "flags": 0,
+ "description": "networkMode for managed cluster snapshot."
+ },
+ "loadBalancerSku": {
+ "type": {
+ "$ref": "#/597"
+ },
+ "flags": 0,
+ "description": "loadBalancerSku for managed cluster snapshot."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "kubenet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/581"
+ },
+ {
+ "$ref": "#/582"
+ },
+ {
+ "$ref": "#/583"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "overlay"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/585"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "calico"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "azure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cilium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/587"
+ },
+ {
+ "$ref": "#/588"
+ },
+ {
+ "$ref": "#/589"
+ },
+ {
+ "$ref": "#/590"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "transparent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "bridge"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/592"
+ },
+ {
+ "$ref": "#/593"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/595"
+ },
+ {
+ "$ref": "#/596"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedclustersnapshots@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/574"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^([A-Za-z0-9-])+$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/600"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/601"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/602"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/604"
+ },
+ "flags": 1,
+ "description": "Properties for trusted access role binding"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrustedAccessRoleBindingProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/610"
+ },
+ "flags": 2,
+ "description": "The current provisioning state of trusted access role binding."
+ },
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ARM resource ID of source resource that trusted access is configured for."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/611"
+ },
+ "flags": 1,
+ "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/605"
+ },
+ {
+ "$ref": "#/606"
+ },
+ {
+ "$ref": "#/607"
+ },
+ {
+ "$ref": "#/608"
+ },
+ {
+ "$ref": "#/609"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/603"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/loadBalancers"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/loadBalancers",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/475"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/613"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/614"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/616"
+ },
+ "flags": 0,
+ "description": "The properties of the load balancer."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LoadBalancerProperties",
+ "properties": {
+ "primaryAgentPoolName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer."
+ },
+ "allowServicePlacement": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it."
+ },
+ "serviceLabelSelector": {
+ "type": {
+ "$ref": "#/617"
+ },
+ "flags": 0,
+ "description": "Only services that must match this selector can be placed on this load balancer."
+ },
+ "serviceNamespaceSelector": {
+ "type": {
+ "$ref": "#/617"
+ },
+ "flags": 0,
+ "description": "Services created in namespaces that match the selector can be placed on this load balancer."
+ },
+ "nodeSelector": {
+ "type": {
+ "$ref": "#/617"
+ },
+ "flags": 0,
+ "description": "Nodes that match this selector will be possible members of this load balancer."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The current provisioning state."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LabelSelector",
+ "properties": {
+ "matchLabels": {
+ "type": {
+ "$ref": "#/618"
+ },
+ "flags": 0,
+ "description": "matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is `key`, the operator is `In`, and the values array contains only `value`. The requirements are ANDed."
+ },
+ "matchExpressions": {
+ "type": {
+ "$ref": "#/626"
+ },
+ "flags": 0,
+ "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LabelSelectorRequirement",
+ "properties": {
+ "key": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "key is the label key that the selector applies to."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/624"
+ },
+ "flags": 0,
+ "description": "operator represents a key's relationship to a set of values. Valid operators are In and NotIn"
+ },
+ "values": {
+ "type": {
+ "$ref": "#/625"
+ },
+ "flags": 0,
+ "description": "values is an array of string values, the values array must be non-empty."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotIn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Exists"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DoesNotExist"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/620"
+ },
+ {
+ "$ref": "#/621"
+ },
+ {
+ "$ref": "#/622"
+ },
+ {
+ "$ref": "#/623"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/619"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/loadBalancers@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/615"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/guardrailsVersions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/guardrailsVersions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/628"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/629"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/630"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/632"
+ },
+ "flags": 2,
+ "description": "Whether the version is default or not and support info."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GuardrailsAvailableVersionsProperties",
+ "properties": {
+ "isDefaultVersion": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ },
+ "support": {
+ "type": {
+ "$ref": "#/635"
+ },
+ "flags": 2,
+ "description": "Whether the version is preview or stable."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Preview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/633"
+ },
+ {
+ "$ref": "#/634"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/guardrailsVersions@2025-02-02-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/631"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/safeguardsVersions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/safeguardsVersions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/628"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/637"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/638"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/640"
+ },
+ "flags": 2,
+ "description": "Whether the version is default or not and support info."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SafeguardsAvailableVersionsProperties",
+ "properties": {
+ "isDefaultVersion": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ },
+ "support": {
+ "type": {
+ "$ref": "#/643"
+ },
+ "flags": 2,
+ "description": "Whether the version is preview or stable."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Preview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/641"
+ },
+ {
+ "$ref": "#/642"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/safeguardsVersions@2025-02-02-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/639"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/locations/meshRevisionProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/645"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/646"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/647"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/649"
+ },
+ "flags": 2,
+ "description": "Mesh revision profile properties for a mesh"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevisionProfileProperties",
+ "properties": {
+ "meshRevisions": {
+ "type": {
+ "$ref": "#/655"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshRevision",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/651"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/654"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CompatibleVersions",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The product/service name."
+ },
+ "versions": {
+ "type": {
+ "$ref": "#/653"
+ },
+ "flags": 0,
+ "description": "Product/service versions compatible with a service mesh add-on revision."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/652"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/650"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/locations/meshRevisionProfiles@2025-02-02-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/648"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/645"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/657"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/658"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/660"
+ },
+ "flags": 2,
+ "description": "Mesh upgrade profile properties for a major.minor release."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MeshUpgradeProfileProperties",
+ "properties": {
+ "revision": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The revision of the mesh release."
+ },
+ "upgrades": {
+ "type": {
+ "$ref": "#/661"
+ },
+ "flags": 0,
+ "description": "List of revisions available for upgrade of a specific mesh revision"
+ },
+ "compatibleWith": {
+ "type": {
+ "$ref": "#/662"
+ },
+ "flags": 0,
+ "description": "List of items this revision of service mesh is compatible with, and their associated versions."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/652"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/659"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/managedClusters/agentPools/machines"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/664"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/665"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/666"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/668"
+ },
+ "flags": 2,
+ "description": "The properties of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineProperties",
+ "properties": {
+ "network": {
+ "type": {
+ "$ref": "#/669"
+ },
+ "flags": 2,
+ "description": "network properties of the machine"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Arm resource id of the machine. It can be used to GET underlying VM Instance"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineNetworkProperties",
+ "properties": {
+ "ipAddresses": {
+ "type": {
+ "$ref": "#/674"
+ },
+ "flags": 2,
+ "description": "IPv4, IPv6 addresses of the machine"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MachineIpAddress",
+ "properties": {
+ "family": {
+ "type": {
+ "$ref": "#/673"
+ },
+ "flags": 2,
+ "description": "To determine if address belongs IPv4 or IPv6 family"
+ },
+ "ip": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "IPv4 or IPv6 address of the machine"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv4"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IPv6"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/671"
+ },
+ {
+ "$ref": "#/672"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/670"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/machines@2025-02-02-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/667"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterAccessProfile",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/677"
+ },
+ "flags": 0,
+ "description": "AccessProfile of a managed cluster."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/678"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessProfile",
+ "properties": {
+ "kubeConfig": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 0,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters/accessProfiles",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/676"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResults",
+ "properties": {
+ "kubeconfigs": {
+ "type": {
+ "$ref": "#/682"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CredentialResult",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/681"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterAdminCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/680"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/680"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listClusterMonitoringUserCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/680"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetServicePrincipalProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "input": {
+ "$ref": "#/149"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resetAADProfile",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "input": {
+ "$ref": "#/259"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters",
+ "apiVersion": "2025-02-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateClusterCertificates",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rotateServiceAccountSigningKeys",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stop",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandRequest",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The command to run."
+ },
+ "context": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A base64 encoded zip file containing the files required by the command."
+ },
+ "clusterToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "AuthToken issued for AKS AAD Server App."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RunCommandResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command id."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/695"
+ },
+ "flags": 0,
+ "description": "Properties of command result."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandResultProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "provisioning State"
+ },
+ "exitCode": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 2,
+ "description": "The exit code of the command"
+ },
+ "startedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command started."
+ },
+ "finishedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time when the command finished."
+ },
+ "logs": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The command output."
+ },
+ "reason": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "An explanation of why provisioningState is set to failed (if so)."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "runCommand",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/694"
+ },
+ "input": {
+ "$ref": "#/693"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RebalanceLoadBalancersRequestBody",
+ "properties": {
+ "loadBalancerNames": {
+ "type": {
+ "$ref": "#/698"
+ },
+ "flags": 0,
+ "description": "The load balancer names list."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rebalanceLoadBalancers",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "input": {
+ "$ref": "#/697"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resolvePrivateLinkServiceId",
+ "resourceType": "Microsoft.ContainerService/managedClusters",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/284"
+ },
+ "input": {
+ "$ref": "#/284"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredential",
+ "resourceType": "Microsoft.ContainerService/managedClusters/namespaces",
+ "apiVersion": "2025-02-02-preview",
+ "output": {
+ "$ref": "#/680"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "abort",
+ "resourceType": "Microsoft.ContainerService/managedclusters/agentPools",
+ "apiVersion": "2025-02-02-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentPoolDeleteMachinesParameter",
+ "properties": {
+ "machineNames": {
+ "type": {
+ "$ref": "#/704"
+ },
+ "flags": 1,
+ "description": "The agent pool machine names."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deleteMachines",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-02-02-preview",
+ "input": {
+ "$ref": "#/703"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "upgradeNodeImageVersion",
+ "resourceType": "Microsoft.ContainerService/managedClusters/agentPools",
+ "apiVersion": "2025-02-02-preview"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/containerservice/microsoft.containerservice/2025-03-01/types.json b/internal/azure/generated/containerservice/microsoft.containerservice/2025-03-01/types.json
new file mode 100644
index 000000000..7105c49f9
--- /dev/null
+++ b/internal/azure/generated/containerservice/microsoft.containerservice/2025-03-01/types.json
@@ -0,0 +1,2045 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/fleets"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/fleets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 0,
+ "description": "Managed identity."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 2,
+ "description": "The status of the last operation."
+ },
+ "hubProfile": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 0,
+ "description": "The FleetHubProfile configures the Fleet's hub."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 2,
+ "description": "Status information for the fleet."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetHubProfile",
+ "properties": {
+ "dnsPrefix": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "DNS prefix used to create the FQDN for the Fleet hub."
+ },
+ "apiServerAccessProfile": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The access profile for the Fleet hub API server."
+ },
+ "agentProfile": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "The agent profile for the Fleet hub."
+ },
+ "fqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The FQDN of the Fleet hub."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Kubernetes version of the Fleet hub."
+ },
+ "portalFqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Azure Portal FQDN of the Fleet hub."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 54,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "APIServerAccessProfile",
+ "properties": {
+ "enablePrivateCluster": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether to create the Fleet hub as a private cluster or not."
+ },
+ "enableVnetIntegration": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "Whether to enable apiserver vnet integration for the Fleet hub or not."
+ },
+ "subnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet."
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AgentProfile",
+ "properties": {
+ "subnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used."
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The virtual machine size of the Fleet hub."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetStatus",
+ "properties": {
+ "lastOperationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The last operation ID for the fleet."
+ },
+ "lastOperationError": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 2,
+ "description": "The last operation error for the fleet."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ErrorDetail",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The error code."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The error message."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The error target."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/20"
+ },
+ "flags": 2,
+ "description": "The error details."
+ },
+ "additionalInfo": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 2,
+ "description": "The error additional info."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/19"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ErrorAdditionalInfo",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The additional info type."
+ },
+ "info": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 2,
+ "description": "The additional info."
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/21"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned, UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/26"
+ },
+ {
+ "$ref": "#/27"
+ },
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/29"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "The principal ID of the assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "The client ID of the assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/31"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/fleets@2025-03-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 50,
+ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/fleets/autoUpgradeProfiles"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/fleets/autoUpgradeProfiles",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/47"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/50"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoUpgradeProfileProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the AutoUpgradeProfile resource."
+ },
+ "updateStrategyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet."
+ },
+ "channel": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 1,
+ "description": "Configures how auto-upgrade will be run."
+ },
+ "nodeImageSelection": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "The node image upgrade to be applied to the target clusters in auto upgrade."
+ },
+ "disabled": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule.\nIf set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters.\nThis is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile.\nBy default, this is set to False."
+ },
+ "autoUpgradeProfileStatus": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "The status of the auto upgrade profile."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/51"
+ },
+ {
+ "$ref": "#/52"
+ },
+ {
+ "$ref": "#/53"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rapid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeImage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/55"
+ },
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoUpgradeNodeImageSelection",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 1,
+ "description": "The node image upgrade type."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Latest"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Consistent"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoUpgradeProfileStatus",
+ "properties": {
+ "lastTriggeredAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The UTC time of the last attempt to automatically create and start an UpdateRun as triggered by the release of new versions."
+ },
+ "lastTriggerStatus": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 2,
+ "description": "The status of the last AutoUpgrade trigger."
+ },
+ "lastTriggerError": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 2,
+ "description": "The error details of the last trigger."
+ },
+ "lastTriggerUpgradeVersions": {
+ "type": {
+ "$ref": "#/67"
+ },
+ "flags": 2,
+ "description": "The target Kubernetes version or node image versions of the last trigger."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/fleets/autoUpgradeProfiles@2025-03-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/49"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/fleets/members"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/fleets/members",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetMemberProperties",
+ "properties": {
+ "clusterResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}'."
+ },
+ "group": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "The group this member belongs to for multi-cluster update management."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 2,
+ "description": "The status of the last operation."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/80"
+ },
+ "flags": 2,
+ "description": "Status information of the last operation for fleet member."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Joining"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Leaving"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/74"
+ },
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetMemberStatus",
+ "properties": {
+ "lastOperationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The last operation ID for the fleet member"
+ },
+ "lastOperationError": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 2,
+ "description": "The last operation error of the fleet member"
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/fleets/members@2025-03-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/71"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/fleets/updateRuns"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/fleets/updateRuns",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/83"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateRunProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the UpdateRun resource."
+ },
+ "updateStrategyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource id of the FleetUpdateStrategy resource to reference.\n\nWhen creating a new run, there are three ways to define a strategy for the run:\n1. Define a new strategy in place: Set the \"strategy\" field.\n2. Use an existing strategy: Set the \"updateStrategyId\" field. (since 2023-08-15-preview)\n3. Use the default strategy to update all the members one by one: Leave both \"updateStrategyId\" and \"strategy\" unset. (since 2023-08-15-preview)\n\nSetting both \"updateStrategyId\" and \"strategy\" is invalid.\n\nUpdateRuns created by \"updateStrategyId\" snapshot the referenced UpdateStrategy at the time of creation and store it in the \"strategy\" field. \nSubsequent changes to the referenced FleetUpdateStrategy resource do not propagate.\nUpdateRunStrategy changes can be made directly on the \"strategy\" field before launching the UpdateRun."
+ },
+ "strategy": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "The strategy defines the order in which the clusters will be updated.\nIf not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.\nThe strategy of the UpdateRun can be modified until the run is started."
+ },
+ "managedClusterUpdate": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 1,
+ "description": "The update to be applied to all clusters in the UpdateRun. The managedClusterUpdate can be modified until the run is started."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 2,
+ "description": "The status of the UpdateRun."
+ },
+ "autoUpgradeProfileId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "AutoUpgradeProfileId is the id of an auto upgrade profile resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/88"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateRunStrategy",
+ "properties": {
+ "stages": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 1,
+ "description": "The list of stages that compose this update run. Min size: 1."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateStage",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 1,
+ "description": "The name of the stage. Must be unique within the UpdateRun."
+ },
+ "groups": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1."
+ },
+ "afterStageWaitInSeconds": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateGroup",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 1,
+ "description": "Name of the group.\nIt must match a group name of an existing fleet member."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/92"
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/91"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterUpdate",
+ "properties": {
+ "upgrade": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 1,
+ "description": "The upgrade to apply to the ManagedClusters."
+ },
+ "nodeImageSelection": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 0,
+ "description": "The node image upgrade to be applied to the target nodes in update run."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedClusterUpgradeSpec",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 1,
+ "description": "ManagedClusterUpgradeType is the type of upgrade to be applied."
+ },
+ "kubernetesVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Kubernetes version to upgrade the member clusters to."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Full"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NodeImageOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ControlPlaneOnly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/98"
+ },
+ {
+ "$ref": "#/99"
+ },
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NodeImageSelection",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 1,
+ "description": "The node image upgrade type."
+ },
+ "customNodeImageVersions": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 0,
+ "description": "Custom node image versions to upgrade the nodes to. This field is required if node image selection type is Custom. Otherwise, it must be empty. For each node image family (e.g., 'AKSUbuntu-1804gen2containerd'), this field can contain at most one version (e.g., only one of 'AKSUbuntu-1804gen2containerd-2023.01.12' or 'AKSUbuntu-1804gen2containerd-2023.02.12', not both). If the nodes belong to a family without a matching image version in this field, they are not upgraded."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Latest"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Consistent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/105"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NodeImageVersion",
+ "properties": {
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13')."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/107"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateRunStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/110"
+ },
+ "flags": 2,
+ "description": "The status of the UpdateRun."
+ },
+ "stages": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 2,
+ "description": "The stages composing an update run. Stages are run sequentially withing an UpdateRun."
+ },
+ "nodeImageSelection": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 2,
+ "description": "The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateStatus",
+ "properties": {
+ "startTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time the operation or group was started."
+ },
+ "completedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time the operation or group was completed."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/118"
+ },
+ "flags": 2,
+ "description": "The State of the operation or group."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/19"
+ },
+ "flags": 2,
+ "description": "The error details when a failure is encountered."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopping"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/114"
+ },
+ {
+ "$ref": "#/115"
+ },
+ {
+ "$ref": "#/116"
+ },
+ {
+ "$ref": "#/117"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateStageStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/110"
+ },
+ "flags": 2,
+ "description": "The status of the UpdateStage."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the UpdateStage."
+ },
+ "groups": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 2,
+ "description": "The list of groups to be updated as part of this UpdateStage."
+ },
+ "afterStageWaitStatus": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 2,
+ "description": "The status of the wait period configured on the UpdateStage."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateGroupStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/110"
+ },
+ "flags": 2,
+ "description": "The status of the UpdateGroup."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the UpdateGroup."
+ },
+ "members": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 2,
+ "description": "The list of member this UpdateGroup updates."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MemberUpdateStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/110"
+ },
+ "flags": 2,
+ "description": "The status of the MemberUpdate operation."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the FleetMember."
+ },
+ "clusterResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Azure resource id of the target Kubernetes cluster."
+ },
+ "operationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The operation resource id of the latest attempt to perform the operation."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The status message after processing the member update operation."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/121"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/120"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WaitStatus",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/110"
+ },
+ "flags": 2,
+ "description": "The status of the wait duration."
+ },
+ "waitDurationInSeconds": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 2,
+ "description": "The wait duration configured in seconds."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/119"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NodeImageSelectionStatus",
+ "properties": {
+ "selectedNodeImageVersions": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 2,
+ "description": "The image versions to upgrade the nodes to."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/107"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/fleets/updateRuns@2025-03-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/84"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.ContainerService/fleets/updateStrategies"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.ContainerService/fleets/updateStrategies",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetUpdateStrategyProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the UpdateStrategy resource."
+ },
+ "strategy": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 1,
+ "description": "Defines the update sequence of the clusters."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/134"
+ },
+ {
+ "$ref": "#/135"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.ContainerService/fleets/updateStrategies@2025-03-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/131"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetCredentialResults",
+ "properties": {
+ "kubeconfigs": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 2,
+ "description": "Array of base64-encoded Kubernetes configuration files."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetCredentialResult",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 2,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/139"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listCredentials",
+ "resourceType": "Microsoft.ContainerService/fleets",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/138"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GenerateResponse",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 3,
+ "description": "The ARM resource id of the generated UpdateRun. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}'."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "generateUpdateRun",
+ "resourceType": "Microsoft.ContainerService/fleets/autoUpgradeProfiles",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/142"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SkipProperties",
+ "properties": {
+ "targets": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 1,
+ "description": "The targets to skip."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SkipTarget",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/150"
+ },
+ "flags": 1,
+ "description": "The skip target type."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The skip target's name. \nTo skip a member/group/stage, use the member/group/stage's name;\nTp skip an after stage wait, use the parent stage's name."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Member"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Group"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AfterStageWait"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/147"
+ },
+ {
+ "$ref": "#/148"
+ },
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/145"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateRun",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "skip",
+ "resourceType": "Microsoft.ContainerService/fleets/updateRuns",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/152"
+ },
+ "input": {
+ "$ref": "#/144"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.ContainerService/fleets/updateRuns",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/152"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stop",
+ "resourceType": "Microsoft.ContainerService/fleets/updateRuns",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/152"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/contosowidgetmanager/microsoft.contoso/2021-11-01/types.json b/internal/azure/generated/contosowidgetmanager/microsoft.contoso/2021-11-01/types.json
new file mode 100644
index 000000000..fa3ee989a
--- /dev/null
+++ b/internal/azure/generated/contosowidgetmanager/microsoft.contoso/2021-11-01/types.json
@@ -0,0 +1,310 @@
+[
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9-]{3,24}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Contoso/employees"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2021-11-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Contoso/employees",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EmployeeProperties",
+ "properties": {
+ "age": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Age of employee"
+ },
+ "city": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "City of employee"
+ },
+ "profile": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Profile of employee"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 2,
+ "description": "The status of the last operation."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/23"
+ },
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Contoso/employees@2021-11-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/cosmos-db/microsoft.documentdb/2025-04-15/types.json b/internal/azure/generated/cosmos-db/microsoft.documentdb/2025-04-15/types.json
new file mode 100644
index 000000000..4ac1020ce
--- /dev/null
+++ b/internal/azure/generated/cosmos-db/microsoft.documentdb/2025-04-15/types.json
@@ -0,0 +1,9447 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 50,
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "Indicates the type of database account. This can only be set at database account creation."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB database accounts."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "The system meta data relating to this resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GlobalDocumentDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Parse"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/5"
+ },
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/14"
+ },
+ "flags": 0,
+ "description": "The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned,UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/13"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/15"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties",
+ "properties": {
+ "consistencyPolicy": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "The consistency policy for the Cosmos DB account."
+ },
+ "locations": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 1,
+ "description": "An array that contains the georeplication locations enabled for the Cosmos DB account."
+ },
+ "databaseAccountOfferType": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 1,
+ "description": "The offer type for the database"
+ },
+ "ipRules": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "List of IpRules."
+ },
+ "isVirtualNetworkFilterEnabled": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules."
+ },
+ "enableAutomaticFailover": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account."
+ },
+ "capabilities": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "List of Cosmos DB capabilities for the account"
+ },
+ "virtualNetworkRules": {
+ "type": {
+ "$ref": "#/37"
+ },
+ "flags": 0,
+ "description": "List of Virtual Network ACL rules configured for the Cosmos DB account."
+ },
+ "enableMultipleWriteLocations": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Enables the account to write in multiple locations"
+ },
+ "enableCassandraConnector": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Enables the cassandra connector on the Cosmos DB C* account"
+ },
+ "connectorOffer": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "The cassandra connector offer type for the Cosmos DB database C* account."
+ },
+ "disableKeyBasedMetadataWriteAccess": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys"
+ },
+ "keyVaultKeyUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URI of the key vault"
+ },
+ "defaultIdentity": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/43"
+ },
+ "flags": 0,
+ "description": "Whether requests from Public Network are allowed"
+ },
+ "enableFreeTier": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether Free Tier is enabled."
+ },
+ "apiProperties": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 0,
+ "description": "API specific properties. Currently, supported only for MongoDB API."
+ },
+ "enableAnalyticalStorage": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether to enable storage analytics."
+ },
+ "analyticalStorageConfiguration": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "Analytical storage specific properties."
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of account creation."
+ },
+ "backupPolicy": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "The object representing the policy for taking backups on an account."
+ },
+ "cors": {
+ "type": {
+ "$ref": "#/84"
+ },
+ "flags": 0,
+ "description": "The CORS policy for the Cosmos DB database account."
+ },
+ "networkAclBypass": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "Indicates what services are allowed to bypass firewall checks."
+ },
+ "networkAclBypassResourceIds": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account."
+ },
+ "disableLocalAuth": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore."
+ },
+ "capacity": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "The object that represents all properties related to capacity enforcement on an account."
+ },
+ "keysMetadata": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 2,
+ "description": "This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account."
+ },
+ "enablePartitionMerge": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account"
+ },
+ "minimalTlsVersion": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 0,
+ "description": "Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2."
+ },
+ "enableBurstCapacity": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of Burst Capacity feature on the account"
+ },
+ "customerManagedKeyStatus": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance."
+ },
+ "enablePerRegionPerPartitionAutoscale": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed."
+ },
+ "documentEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The connection endpoint for the Cosmos DB database account."
+ },
+ "writeLocations": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 2,
+ "description": "An array that contains the write location for the Cosmos DB account."
+ },
+ "readLocations": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 2,
+ "description": "An array that contains of the read locations enabled for the Cosmos DB account."
+ },
+ "failoverPolicies": {
+ "type": {
+ "$ref": "#/110"
+ },
+ "flags": 2,
+ "description": "An array that contains the regions ordered by their failover priorities."
+ },
+ "privateEndpointConnections": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 2,
+ "description": "List of Private Endpoint Connections configured for the Cosmos DB account."
+ },
+ "instanceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A unique identifier assigned to the database account"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConsistencyPolicy",
+ "properties": {
+ "defaultConsistencyLevel": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 1,
+ "description": "The default consistency level and configuration settings of the Cosmos DB account."
+ },
+ "maxStalenessPrefix": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'."
+ },
+ "maxIntervalInSeconds": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 0,
+ "description": "When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Eventual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Session"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BoundedStaleness"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Strong"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConsistentPrefix"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/23"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 2147483647
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 5,
+ "maxValue": 86400
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Location",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unique identifier of the region within the database account. Example: <accountName>-<locationName>."
+ },
+ "locationName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the region."
+ },
+ "documentEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed."
+ },
+ "failoverPriority": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists."
+ },
+ "isZoneRedundant": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether or not this region is an AvailabilityZone region"
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/27"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IpAddressOrRange",
+ "properties": {
+ "ipAddressOrRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/32"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Capability",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/34"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualNetworkRule",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}."
+ },
+ "ignoreMissingVNetServiceEndpoint": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Create firewall rule before the virtual network has vnet service endpoint enabled."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/36"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Small"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecuredByPerimeter"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApiProperties",
+ "properties": {
+ "serverVersion": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Describes the version of the MongoDB account."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "3.2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "3.6"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "4.0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "4.2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "5.0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "6.0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "7.0"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/51"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AnalyticalStorageConfiguration",
+ "properties": {
+ "schemaType": {
+ "type": {
+ "$ref": "#/56"
+ },
+ "flags": 0,
+ "description": "Describes the types of schema for analytical storage."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WellDefined"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FullFidelity"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/54"
+ },
+ {
+ "$ref": "#/55"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BackupPolicy",
+ "discriminator": "type",
+ "baseProperties": {
+ "migrationState": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 0,
+ "description": "The object representing the state of the migration between the backup policies."
+ }
+ },
+ "elements": {
+ "Continuous": {
+ "$ref": "#/70"
+ },
+ "Periodic": {
+ "$ref": "#/76"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupPolicyMigrationState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 0,
+ "description": "Describes the status of migration between backup policy types."
+ },
+ "targetType": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 0,
+ "description": "Describes the target backup policy type of the backup policy migration."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Time at which the backup policy migration started (ISO-8601 format)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Periodic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousModeBackupPolicy",
+ "properties": {
+ "continuousModeProperties": {
+ "type": {
+ "$ref": "#/71"
+ },
+ "flags": 0,
+ "description": "Configuration values for continuous mode backup"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 1,
+ "description": "Describes the mode of backups."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousModeProperties",
+ "properties": {
+ "tier": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 0,
+ "description": "Enum to indicate type of Continuous backup mode"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous7Days"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous30Days"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PeriodicModeBackupPolicy",
+ "properties": {
+ "periodicModeProperties": {
+ "type": {
+ "$ref": "#/77"
+ },
+ "flags": 0,
+ "description": "Configuration values for periodic mode backup"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 1,
+ "description": "Describes the mode of backups."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PeriodicModeProperties",
+ "properties": {
+ "backupIntervalInMinutes": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "An integer representing the interval in minutes between two backups"
+ },
+ "backupRetentionIntervalInHours": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "An integer representing the time (in hours) that each backup is retained"
+ },
+ "backupStorageRedundancy": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Enum to indicate type of backup residency"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Geo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Local"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Zone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Periodic"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CorsPolicy",
+ "properties": {
+ "allowedOrigins": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The origin domains that are permitted to make a request against the service via CORS."
+ },
+ "allowedMethods": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request."
+ },
+ "allowedHeaders": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The request headers that the origin domain may specify on the CORS request."
+ },
+ "exposedHeaders": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer."
+ },
+ "maxAgeInSeconds": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 0,
+ "description": "The maximum amount time that a browser should cache the preflight OPTIONS request."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/83"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureServices"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestoreParameters",
+ "properties": {
+ "restoreMode": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 0,
+ "description": "Describes the mode of the restore."
+ },
+ "databasesToRestore": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 0,
+ "description": "List of specific databases available for restore."
+ },
+ "gremlinDatabasesToRestore": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "List of specific gremlin databases available for restore."
+ },
+ "tablesToRestore": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 0,
+ "description": "List of specific tables available for restore."
+ },
+ "restoreSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}"
+ },
+ "restoreTimestampInUtc": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Time to which the account has to be restored (ISO-8601 format)."
+ },
+ "restoreWithTtlDisabled": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PointInTime"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/90"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseRestoreResource",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the database available for restore."
+ },
+ "collectionNames": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "The names of the collections available for restore."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/92"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinDatabaseRestoreResource",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the gremlin database available for restore."
+ },
+ "graphNames": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 0,
+ "description": "The names of the graphs available for restore."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/95"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Capacity",
+ "properties": {
+ "totalThroughputLimit": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": -1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountKeysMetadata",
+ "properties": {
+ "primaryMasterKey": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Primary Read-Write Key for the given Cosmos DB database account."
+ },
+ "secondaryMasterKey": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account."
+ },
+ "primaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Primary Read-Only Key for the given Cosmos DB database account."
+ },
+ "secondaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/102"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccountKeyMetadata",
+ "properties": {
+ "generationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tls"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tls11"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tls12"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/105"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/27"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/27"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FailoverPolicy",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>."
+ },
+ "locationName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the region in which the database account exists."
+ },
+ "failoverPriority": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/109"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnection",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/112"
+ },
+ "flags": 0,
+ "description": "Resource properties."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/113"
+ },
+ "flags": 0,
+ "description": "Private endpoint which the connection belongs to."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "Connection State of the Private Endpoint Connection."
+ },
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Group id of the private endpoint."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Provisioning state of the private endpoint."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointProperty",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource id of the private endpoint."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionStateProperty",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The private link service connection description."
+ },
+ "actionsRequired": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/111"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/120"
+ },
+ {
+ "$ref": "#/121"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/124"
+ },
+ {
+ "$ref": "#/125"
+ },
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB SQL database."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a SQL database"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL database"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/137"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_colls": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property that specified the addressable path of the collections resource."
+ },
+ "_users": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property that specifies the addressable path of the users resource."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceRestoreParameters",
+ "properties": {
+ "restoreSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}"
+ },
+ "restoreTimestampInUtc": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Time to which the account has to be restored (ISO-8601 format)."
+ },
+ "restoreWithTtlDisabled": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/135"
+ },
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoscaleSettings",
+ "properties": {
+ "maxThroughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Represents maximum throughput, the resource can scale up to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/131"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/143"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/144"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/145"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a resource throughput"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "minimumThroughput": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The minimum throughput of the resource"
+ },
+ "offerReplacePending": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The throughput replace is pending"
+ },
+ "instantMaximumThroughput": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The offer throughput value to instantly scale up without triggering splits"
+ },
+ "softAllowedMaximumThroughput": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoscaleSettingsResource",
+ "properties": {
+ "maxThroughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 1,
+ "description": "Represents maximum throughput container can scale up to."
+ },
+ "autoUpgradePolicy": {
+ "type": {
+ "$ref": "#/150"
+ },
+ "flags": 0,
+ "description": "Cosmos DB resource auto-upgrade policy"
+ },
+ "targetMaxThroughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "Represents target maximum throughput container can scale up to once offer is no longer in pending state."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoUpgradePolicyResource",
+ "properties": {
+ "throughputPolicy": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 0,
+ "description": "Represents throughput policy which service must adhere to for auto-upgrade"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputPolicyResource",
+ "properties": {
+ "isEnabled": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Determines whether the ThroughputPolicy is active or not"
+ },
+ "incrementPercent": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Represents the percentage by which throughput can increase every time throughput policy kicks in."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/146"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/155"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/157"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB container."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/158"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a container"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlContainerResourceOrSqlContainerGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL container"
+ },
+ "indexingPolicy": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container"
+ },
+ "partitionKey": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 0,
+ "description": "The configuration of the partition key to be used for partitioning data into multiple partitions"
+ },
+ "defaultTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Default time to live"
+ },
+ "uniqueKeyPolicy": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service."
+ },
+ "conflictResolutionPolicy": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "The conflict resolution policy for the container."
+ },
+ "clientEncryptionPolicy": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 0,
+ "description": "The client encryption policy for the container."
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "computedProperties": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "List of computed properties"
+ },
+ "vectorEmbeddingPolicy": {
+ "type": {
+ "$ref": "#/224"
+ },
+ "flags": 0,
+ "description": "The vector embedding policy for the container."
+ },
+ "fullTextPolicy": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "The FullText policy for the container."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IndexingPolicy",
+ "properties": {
+ "automatic": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Indicates if the indexing policy is automatic"
+ },
+ "indexingMode": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "Indicates the indexing mode."
+ },
+ "includedPaths": {
+ "type": {
+ "$ref": "#/178"
+ },
+ "flags": 0,
+ "description": "List of paths to include in the indexing"
+ },
+ "excludedPaths": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "List of paths to exclude from indexing"
+ },
+ "compositeIndexes": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 0,
+ "description": "List of composite path list"
+ },
+ "spatialIndexes": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "List of spatial specifics"
+ },
+ "vectorIndexes": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "List of paths to include in the vector indexing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "consistent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "lazy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/162"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IncludedPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ },
+ "indexes": {
+ "type": {
+ "$ref": "#/177"
+ },
+ "flags": 0,
+ "description": "List of indexes for this path"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Indexes",
+ "properties": {
+ "dataType": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 0,
+ "description": "The datatype for which the indexing behavior is applied to."
+ },
+ "precision": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "The precision of the index. -1 is maximum precision."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 0,
+ "description": "Indicates the type of index."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Number"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Point"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Polygon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LineString"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiPolygon"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/169"
+ },
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hash"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Range"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spatial"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/165"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/164"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExcludedPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/179"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CompositePath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ },
+ "order": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Sort order for composite paths."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ascending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "descending"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/181"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SpatialSpec",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ },
+ "types": {
+ "type": {
+ "$ref": "#/193"
+ },
+ "flags": 0,
+ "description": "List of path's spatial type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Point"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LineString"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Polygon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiPolygon"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/188"
+ },
+ {
+ "$ref": "#/189"
+ },
+ {
+ "$ref": "#/190"
+ },
+ {
+ "$ref": "#/191"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/192"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/187"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VectorIndex",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The path to the vector field in the document."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 1,
+ "description": "The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "flat"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "diskANN"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "quantizedFlat"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/196"
+ },
+ {
+ "$ref": "#/197"
+ },
+ {
+ "$ref": "#/198"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/195"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerPartitionKey",
+ "properties": {
+ "paths": {
+ "type": {
+ "$ref": "#/202"
+ },
+ "flags": 0,
+ "description": "List of paths using which data within the container can be partitioned"
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create"
+ },
+ "version": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "Indicates the version of the partition key definition"
+ },
+ "systemKey": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 2,
+ "description": "Indicates if the container is using a system generated partition key"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hash"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Range"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiHash"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/203"
+ },
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UniqueKeyPolicy",
+ "properties": {
+ "uniqueKeys": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 0,
+ "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UniqueKey",
+ "properties": {
+ "paths": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 0,
+ "description": "List of paths must be unique for each document in the Azure Cosmos DB service"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/209"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConflictResolutionPolicy",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "Indicates the conflict resolution mode."
+ },
+ "conflictResolutionPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The conflict resolution path in the case of LastWriterWins mode."
+ },
+ "conflictResolutionProcedure": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The procedure to resolve conflicts in the case of custom mode."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LastWriterWins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/213"
+ },
+ {
+ "$ref": "#/214"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionPolicy",
+ "properties": {
+ "includedPaths": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 1,
+ "description": "Paths of the item that need encryption along with path-specific settings."
+ },
+ "policyFormatVersion": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 1,
+ "description": "Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionIncludedPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Path that needs to be encrypted."
+ },
+ "clientEncryptionKeyId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The identifier of the Client Encryption Key to be used to encrypt the path."
+ },
+ "encryptionType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The type of encryption to be performed. Eg - Deterministic, Randomized."
+ },
+ "encryptionAlgorithm": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/217"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/219"
+ },
+ {
+ "$ref": "#/220"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ComputedProperty",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of a computed property, for example - \"cp_lowerName\""
+ },
+ "query": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The query that evaluates the value for computed property, for example - \"SELECT VALUE LOWER(c.name) FROM c\""
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/222"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VectorEmbeddingPolicy",
+ "properties": {
+ "vectorEmbeddings": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 0,
+ "description": "List of vector embeddings"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VectorEmbedding",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The path to the vector field in the document."
+ },
+ "dataType": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 1,
+ "description": "Indicates the data type of vector."
+ },
+ "distanceFunction": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 1,
+ "description": "The distance function to use for distance calculation in between vectors."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 1,
+ "description": "The number of dimensions in the vector."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "float32"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "uint8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "int8"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/226"
+ },
+ {
+ "$ref": "#/227"
+ },
+ {
+ "$ref": "#/228"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "euclidean"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cosine"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "dotproduct"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/230"
+ },
+ {
+ "$ref": "#/231"
+ },
+ {
+ "$ref": "#/232"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/225"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FullTextPolicy",
+ "properties": {
+ "defaultLanguage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The default language for a full text paths."
+ },
+ "fullTextPaths": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "List of FullText Paths"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FullTextPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The path to the full text field in the document."
+ },
+ "language": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The language of the full text field in the document."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/236"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrSqlContainerGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/156"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/245"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/244"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/247"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/250"
+ },
+ "flags": 1,
+ "description": "Properties to create and update ClientEncryptionKey."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a ClientEncryptionKey"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the ClientEncryptionKey"
+ },
+ "encryptionAlgorithm": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
+ },
+ "wrappedDataEncryptionKey": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "Wrapped (encrypted) form of the key represented as a byte array."
+ },
+ "keyWrapMetadata": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyWrapMetadata",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of associated KeyEncryptionKey (aka CustomerManagedKey)."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "ProviderName of KeyStoreProvider."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Reference / link to the KeyEncryptionKey."
+ },
+ "algorithm": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Algorithm used in wrapping and unwrapping of the data encryption key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/249"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB storedProcedure."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlStoredProcedureCreateUpdatePropertiesOrSqlStoredProcedureGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a storedProcedure"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 4,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlStoredProcedureResourceOrSqlStoredProcedureGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL storedProcedure"
+ },
+ "body": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Body of the Stored Procedure"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/257"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/266"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB userDefinedFunction."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a userDefinedFunction"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 4,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL userDefinedFunction"
+ },
+ "body": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Body of the User Defined Function"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/265"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/270"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/271"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/273"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB trigger."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/284"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlTriggerCreateUpdatePropertiesOrSqlTriggerGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/274"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a trigger"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 4,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlTriggerResourceOrSqlTriggerGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL trigger"
+ },
+ "body": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Body of the Trigger"
+ },
+ "triggerType": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 0,
+ "description": "Type of the Trigger"
+ },
+ "triggerOperation": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 0,
+ "description": "The operation the trigger is associated with"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pre"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Post"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/275"
+ },
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "All"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Create"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Update"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replace"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/281"
+ },
+ {
+ "$ref": "#/282"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/272"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/289"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB SQL Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlRoleDefinitionResource",
+ "properties": {
+ "roleName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "assignableScopes": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist."
+ },
+ "permissions": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 0,
+ "description": "The set of operations allowed through this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/290"
+ },
+ {
+ "$ref": "#/291"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Permission",
+ "properties": {
+ "dataActions": {
+ "type": {
+ "$ref": "#/295"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are allowed."
+ },
+ "notDataActions": {
+ "type": {
+ "$ref": "#/296"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are denied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/294"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/288"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB SQL Role Assignment."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlRoleAssignmentResource",
+ "properties": {
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated Role Definition."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The data plane resource path for which access is being granted through this Role Assignment."
+ },
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/301"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB MongoDB database."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a MongoDB database"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB MongoDB database"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/309"
+ },
+ {
+ "$ref": "#/310"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/306"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/315"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/318"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB MongoDB collection."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/336"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a MongoDB collection"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB MongoDB collection"
+ },
+ "shardKey": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 0,
+ "description": "A key-value pair of shard keys to be applied for the request."
+ },
+ "indexes": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 0,
+ "description": "List of index keys"
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/334"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ShardKeys",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoIndex",
+ "properties": {
+ "key": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 0,
+ "description": "Cosmos DB MongoDB collection index keys"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 0,
+ "description": "Cosmos DB MongoDB collection index key options"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoIndexKeys",
+ "properties": {
+ "keys": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 0,
+ "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoIndexOptions",
+ "properties": {
+ "expireAfterSeconds": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Expire after seconds"
+ },
+ "unique": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Is unique or not"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/327"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/332"
+ },
+ {
+ "$ref": "#/333"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/323"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/339"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/340"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/342"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/341"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/344"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/345"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Mongo Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoRoleDefinitionResource",
+ "properties": {
+ "roleName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/350"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The database name for which access is being granted for this Role Definition."
+ },
+ "privileges": {
+ "type": {
+ "$ref": "#/354"
+ },
+ "flags": 0,
+ "description": "A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 0,
+ "description": "The set of roles inherited by this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Privilege",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/352"
+ },
+ "flags": 0,
+ "description": "An Azure Cosmos DB Mongo DB Resource."
+ },
+ "actions": {
+ "type": {
+ "$ref": "#/353"
+ },
+ "flags": 0,
+ "description": "An array of actions that are allowed."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivilegeResource",
+ "properties": {
+ "db": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The database name the role is applied."
+ },
+ "collection": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The collection name the role is applied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/351"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Role",
+ "properties": {
+ "db": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The database name the role is applied."
+ },
+ "role": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The role name."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/355"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/346"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/358"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/359"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Mongo User Definition."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoUserDefinitionResource",
+ "properties": {
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The user name for User Definition."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The password for User Definition. Response does not contain user password."
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The database name for which access is being granted for this User Definition."
+ },
+ "customData": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A custom definition for the USer Definition."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/362"
+ },
+ "flags": 0,
+ "description": "The set of roles inherited by the User Definition."
+ },
+ "mechanisms": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/355"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/360"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/tables"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/365"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Table."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TableCreateUpdatePropertiesOrTableGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/368"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Table"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/372"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TableResourceOrTableGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB table"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/371"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/370"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrTableGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/366"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/375"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/379"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/378"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/381"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/382"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/384"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/387"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/385"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Cassandra keyspace"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/386"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Cassandra keyspace"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/383"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/389"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/391"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/393"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/392"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/396"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/398"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Cassandra table."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/408"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/399"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Cassandra table"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraTableResourceOrCassandraTableGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Cassandra table"
+ },
+ "defaultTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Time to live of the Cosmos DB Cassandra table"
+ },
+ "schema": {
+ "type": {
+ "$ref": "#/400"
+ },
+ "flags": 0,
+ "description": "Schema of the Cosmos DB Cassandra table"
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraSchema",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/402"
+ },
+ "flags": 0,
+ "description": "List of Cassandra table columns."
+ },
+ "partitionKeys": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 0,
+ "description": "List of partition key."
+ },
+ "clusterKeys": {
+ "type": {
+ "$ref": "#/406"
+ },
+ "flags": 0,
+ "description": "List of cluster key."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Column",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB Cassandra table column"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Type of the Cosmos DB Cassandra table column"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/401"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraPartitionKey",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB Cassandra table partition key"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/403"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterKey",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB Cassandra table cluster key"
+ },
+ "orderBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\""
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/405"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrCassandraTableGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/397"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/410"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/414"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/413"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/416"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Gremlin database."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/425"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/420"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Gremlin database"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/424"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Gremlin database"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/423"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/421"
+ },
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/418"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/427"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/428"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/429"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/430"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/433"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/434"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Gremlin graph."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/442"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/437"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Gremlin graph"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/441"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinGraphResourceOrGremlinGraphGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Gremlin graph"
+ },
+ "indexingPolicy": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph"
+ },
+ "partitionKey": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 0,
+ "description": "The configuration of the partition key to be used for partitioning data into multiple partitions"
+ },
+ "defaultTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Default time to live"
+ },
+ "uniqueKeyPolicy": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service."
+ },
+ "conflictResolutionPolicy": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "The conflict resolution policy for the graph."
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/438"
+ },
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/435"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/446"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/448"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/447"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 100,
+ "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/cassandraClusters"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/cassandraClusters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/450"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/451"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/452"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 0,
+ "description": "Properties of a managed Cassandra cluster."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/478"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/479"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterResourceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 0,
+ "description": "The status of the resource at the time the operation was called."
+ },
+ "restoreFromBackupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 4,
+ "description": "To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup."
+ },
+ "delegatedManagementSubnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'"
+ },
+ "cassandraVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version."
+ },
+ "clusterNameOverride": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property."
+ },
+ "authenticationMethod": {
+ "type": {
+ "$ref": "#/465"
+ },
+ "flags": 0,
+ "description": "Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'."
+ },
+ "initialCassandraAdminPassword": {
+ "type": {
+ "$ref": "#/466"
+ },
+ "flags": 4,
+ "description": "Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'."
+ },
+ "prometheusEndpoint": {
+ "type": {
+ "$ref": "#/467"
+ },
+ "flags": 0,
+ "description": "Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached."
+ },
+ "repairEnabled": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs."
+ },
+ "clientCertificates": {
+ "type": {
+ "$ref": "#/469"
+ },
+ "flags": 0,
+ "description": "List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property."
+ },
+ "externalGossipCertificates": {
+ "type": {
+ "$ref": "#/470"
+ },
+ "flags": 0,
+ "description": "List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property."
+ },
+ "gossipCertificates": {
+ "type": {
+ "$ref": "#/471"
+ },
+ "flags": 2,
+ "description": "List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property."
+ },
+ "externalSeedNodes": {
+ "type": {
+ "$ref": "#/472"
+ },
+ "flags": 0,
+ "description": "List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes."
+ },
+ "seedNodes": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 2,
+ "description": "List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes."
+ },
+ "hoursBetweenBackups": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "(Deprecated) Number of hours to wait between taking a backup of the cluster."
+ },
+ "deallocated": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Whether the cluster and associated data centers has been deallocated."
+ },
+ "cassandraAuditLoggingEnabled": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Whether Cassandra audit logging is enabled"
+ },
+ "provisionError": {
+ "type": {
+ "$ref": "#/474"
+ },
+ "flags": 0,
+ "description": "Error related to resource provisioning."
+ },
+ "azureConnectionMethod": {
+ "type": {
+ "$ref": "#/477"
+ },
+ "flags": 0,
+ "description": "How to connect to the azure services needed for running the cluster"
+ },
+ "privateLinkResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/455"
+ },
+ {
+ "$ref": "#/456"
+ },
+ {
+ "$ref": "#/457"
+ },
+ {
+ "$ref": "#/458"
+ },
+ {
+ "$ref": "#/459"
+ },
+ {
+ "$ref": "#/460"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cassandra"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ldap"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/462"
+ },
+ {
+ "$ref": "#/463"
+ },
+ {
+ "$ref": "#/464"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SeedNode",
+ "properties": {
+ "ipAddress": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "IP address of this seed node."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Certificate",
+ "properties": {
+ "pem": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "PEM formatted public key."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/468"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/468"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/468"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/467"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/467"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraError",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The code of error that occurred."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The message of the error."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The target resource of the error."
+ },
+ "additionalErrorInfo": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional information about the error."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VPN"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/475"
+ },
+ {
+ "$ref": "#/476"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedCassandraManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The object id of the identity resource."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The tenant id of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/482"
+ },
+ "flags": 0,
+ "description": "The type of the resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/480"
+ },
+ {
+ "$ref": "#/481"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/cassandraClusters@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/453"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/cassandraClusters/dataCenters"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/450"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/484"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/485"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/487"
+ },
+ "flags": 0,
+ "description": "Properties of a managed Cassandra data center."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataCenterResourceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/494"
+ },
+ "flags": 0,
+ "description": "The status of the resource at the time the operation was called."
+ },
+ "dataCenterLocation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The region this data center should be created in."
+ },
+ "delegatedSubnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'."
+ },
+ "nodeCount": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster."
+ },
+ "seedNodes": {
+ "type": {
+ "$ref": "#/495"
+ },
+ "flags": 2,
+ "description": "IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster."
+ },
+ "base64EncodedCassandraYamlFragment": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed."
+ },
+ "managedDiskCustomerKeyUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key."
+ },
+ "backupStorageCustomerKeyUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Indicates the Key Uri of the customer key to use for encryption of the backup storage account."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2"
+ },
+ "diskSku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Disk SKU used for data centers. Default value is P30."
+ },
+ "diskCapacity": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Number of disks attached to each node. Default is 4."
+ },
+ "availabilityZone": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines."
+ },
+ "authenticationMethodLdapProperties": {
+ "type": {
+ "$ref": "#/496"
+ },
+ "flags": 0,
+ "description": "Ldap authentication method properties. This feature is in preview."
+ },
+ "deallocated": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Whether the data center has been deallocated."
+ },
+ "provisionError": {
+ "type": {
+ "$ref": "#/474"
+ },
+ "flags": 0,
+ "description": "Error related to resource provisioning."
+ },
+ "privateEndpointIpAddress": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Ip of the VPN Endpoint for this data center."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/488"
+ },
+ {
+ "$ref": "#/489"
+ },
+ {
+ "$ref": "#/490"
+ },
+ {
+ "$ref": "#/491"
+ },
+ {
+ "$ref": "#/492"
+ },
+ {
+ "$ref": "#/493"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/467"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AuthenticationMethodLdapProperties",
+ "properties": {
+ "serverHostname": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Hostname of the LDAP server."
+ },
+ "serverPort": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Port of the LDAP server."
+ },
+ "serviceUserDistinguishedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Distinguished name of the look up user account, who can look up user details on authentication."
+ },
+ "serviceUserPassword": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password of the look up user."
+ },
+ "searchBaseDistinguishedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Distinguished name of the object to start the recursive search of users from."
+ },
+ "searchFilterTemplate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login."
+ },
+ "serverCertificates": {
+ "type": {
+ "$ref": "#/497"
+ },
+ "flags": 0
+ },
+ "connectionTimeoutInMs": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/468"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/cassandraClusters/dataCenters@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/486"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/499"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/500"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/501"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/502"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/504"
+ },
+ "flags": 2,
+ "description": "Resource properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NotebookWorkspaceProperties",
+ "properties": {
+ "notebookServerEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Specifies the endpoint of Notebook server."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/503"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/506"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/507"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/112"
+ },
+ "flags": 0,
+ "description": "Resource properties."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/508"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 50
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/services"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/services",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/510"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/511"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/512"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/514"
+ },
+ "flags": 0,
+ "description": "Properties in ServiceResourceCreateUpdateParameters."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties",
+ "discriminator": "serviceType",
+ "baseProperties": {
+ "instanceSize": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "Instance type for the service."
+ },
+ "instanceCount": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "Instance count for the service."
+ },
+ "creationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Time of the last state change (ISO-8601 format)."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/525"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ },
+ "elements": {
+ "DataTransfer": {
+ "$ref": "#/526"
+ },
+ "GraphAPICompute": {
+ "$ref": "#/537"
+ },
+ "MaterializedViewsBuilder": {
+ "$ref": "#/548"
+ },
+ "SqlDedicatedGateway": {
+ "$ref": "#/559"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cosmos.D4s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cosmos.D8s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cosmos.D16s"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/515"
+ },
+ {
+ "$ref": "#/516"
+ },
+ {
+ "$ref": "#/517"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/519"
+ },
+ {
+ "$ref": "#/520"
+ },
+ {
+ "$ref": "#/521"
+ },
+ {
+ "$ref": "#/522"
+ },
+ {
+ "$ref": "#/523"
+ },
+ {
+ "$ref": "#/524"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties",
+ "properties": {
+ "locations": {
+ "type": {
+ "$ref": "#/535"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/536"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataTransferRegionalServiceResource",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/534"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/528"
+ },
+ {
+ "$ref": "#/529"
+ },
+ {
+ "$ref": "#/530"
+ },
+ {
+ "$ref": "#/531"
+ },
+ {
+ "$ref": "#/532"
+ },
+ {
+ "$ref": "#/533"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/527"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DataTransfer"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties",
+ "properties": {
+ "graphApiComputeEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "GraphAPICompute endpoint for the service."
+ },
+ "locations": {
+ "type": {
+ "$ref": "#/546"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/547"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GraphAPIComputeRegionalServiceResource",
+ "properties": {
+ "graphApiComputeEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The regional endpoint for GraphAPICompute."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/545"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/539"
+ },
+ {
+ "$ref": "#/540"
+ },
+ {
+ "$ref": "#/541"
+ },
+ {
+ "$ref": "#/542"
+ },
+ {
+ "$ref": "#/543"
+ },
+ {
+ "$ref": "#/544"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/538"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GraphAPICompute"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties",
+ "properties": {
+ "locations": {
+ "type": {
+ "$ref": "#/557"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/558"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaterializedViewsBuilderRegionalServiceResource",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/556"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/550"
+ },
+ {
+ "$ref": "#/551"
+ },
+ {
+ "$ref": "#/552"
+ },
+ {
+ "$ref": "#/553"
+ },
+ {
+ "$ref": "#/554"
+ },
+ {
+ "$ref": "#/555"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/549"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MaterializedViewsBuilder"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties",
+ "properties": {
+ "dedicatedGatewayType": {
+ "type": {
+ "$ref": "#/562"
+ },
+ "flags": 0,
+ "description": "DedicatedGatewayType for the service."
+ },
+ "sqlDedicatedGatewayEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "SqlDedicatedGateway endpoint for the service."
+ },
+ "locations": {
+ "type": {
+ "$ref": "#/571"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/572"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IntegratedCache"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DistributedQuery"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/560"
+ },
+ {
+ "$ref": "#/561"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDedicatedGatewayRegionalServiceResource",
+ "properties": {
+ "sqlDedicatedGatewayEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The regional endpoint for SqlDedicatedGateway."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/570"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/564"
+ },
+ {
+ "$ref": "#/565"
+ },
+ {
+ "$ref": "#/566"
+ },
+ {
+ "$ref": "#/567"
+ },
+ {
+ "$ref": "#/568"
+ },
+ {
+ "$ref": "#/569"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/563"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlDedicatedGateway"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/services@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/513"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/locations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/locations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/574"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/575"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/577"
+ },
+ "flags": 2,
+ "description": "Cosmos DB location metadata"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LocationProperties",
+ "properties": {
+ "supportsAvailabilityZone": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the location supports availability zones or not."
+ },
+ "isResidencyRestricted": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the location is residency sensitive."
+ },
+ "backupStorageRedundancies": {
+ "type": {
+ "$ref": "#/582"
+ },
+ "flags": 2,
+ "description": "The properties of available backup storage redundancies."
+ },
+ "isSubscriptionRegionAccessAllowedForRegular": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the subscription have access in region for Non-Availability Zones."
+ },
+ "isSubscriptionRegionAccessAllowedForAz": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the subscription have access in region for Availability Zones(Az)."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/588"
+ },
+ "flags": 2,
+ "description": "Enum to indicate current buildout status of the region."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Geo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Local"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Zone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/578"
+ },
+ {
+ "$ref": "#/579"
+ },
+ {
+ "$ref": "#/580"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/581"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/583"
+ },
+ {
+ "$ref": "#/584"
+ },
+ {
+ "$ref": "#/585"
+ },
+ {
+ "$ref": "#/586"
+ },
+ {
+ "$ref": "#/587"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/locations@2025-04-15",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/576"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/590"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/591"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/593"
+ },
+ "flags": 2,
+ "description": "Resource properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkResourceProperties",
+ "properties": {
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The private link resource group id."
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/594"
+ },
+ "flags": 2,
+ "description": "The private link resource required member names."
+ },
+ "requiredZoneNames": {
+ "type": {
+ "$ref": "#/595"
+ },
+ "flags": 2,
+ "description": "The private link resource required zone names."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources@2025-04-15",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/592"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FailoverPolicies",
+ "properties": {
+ "failoverPolicies": {
+ "type": {
+ "$ref": "#/598"
+ },
+ "flags": 1,
+ "description": "List of failover policies."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/109"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "failoverPriorityChange",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "input": {
+ "$ref": "#/597"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountListKeysResult",
+ "properties": {
+ "primaryMasterKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the primary read-write key."
+ },
+ "secondaryMasterKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the secondary read-write key."
+ },
+ "primaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the primary read-only key."
+ },
+ "secondaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the secondary read-only key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listKeys",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/600"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountListConnectionStringsResult",
+ "properties": {
+ "connectionStrings": {
+ "type": {
+ "$ref": "#/619"
+ },
+ "flags": 0,
+ "description": "An array that contains the connection strings for the Cosmos DB account."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountConnectionString",
+ "properties": {
+ "connectionString": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Value of the connection string"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Description of the connection string"
+ },
+ "keyKind": {
+ "type": {
+ "$ref": "#/608"
+ },
+ "flags": 2,
+ "description": "Kind of the connection string key"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/618"
+ },
+ "flags": 2,
+ "description": "Type of the connection string"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Primary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Secondary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PrimaryReadonly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecondaryReadonly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/604"
+ },
+ {
+ "$ref": "#/605"
+ },
+ {
+ "$ref": "#/606"
+ },
+ {
+ "$ref": "#/607"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sql"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Table"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cassandra"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CassandraConnectorMetadata"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Gremlin"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlDedicatedGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GremlinV2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Undefined"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/609"
+ },
+ {
+ "$ref": "#/610"
+ },
+ {
+ "$ref": "#/611"
+ },
+ {
+ "$ref": "#/612"
+ },
+ {
+ "$ref": "#/613"
+ },
+ {
+ "$ref": "#/614"
+ },
+ {
+ "$ref": "#/615"
+ },
+ {
+ "$ref": "#/616"
+ },
+ {
+ "$ref": "#/617"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/603"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listConnectionStrings",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/602"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegionForOnlineOffline",
+ "properties": {
+ "region": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Cosmos DB region, with spaces between words and each word capitalized."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "offlineRegion",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "input": {
+ "$ref": "#/621"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "onlineRegion",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "input": {
+ "$ref": "#/621"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountListReadOnlyKeysResult",
+ "properties": {
+ "primaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the primary read-only key."
+ },
+ "secondaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the secondary read-only key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "readonlykeys",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/624"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountRegenerateKeyParameters",
+ "properties": {
+ "keyKind": {
+ "type": {
+ "$ref": "#/631"
+ },
+ "flags": 1,
+ "description": "The access key to regenerate."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "primary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "secondary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "primaryReadonly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "secondaryReadonly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/627"
+ },
+ {
+ "$ref": "#/628"
+ },
+ {
+ "$ref": "#/629"
+ },
+ {
+ "$ref": "#/630"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateKey",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-04-15",
+ "input": {
+ "$ref": "#/626"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsGetResults",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/634"
+ },
+ "flags": 0,
+ "description": "The properties of an Azure Cosmos DB resource throughput"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the ARM resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the ARM resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/636"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/635"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsGetPropertiesResource",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "minimumThroughput": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The minimum throughput of the resource"
+ },
+ "offerReplacePending": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The throughput replace is pending"
+ },
+ "instantMaximumThroughput": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The offer throughput value to instantly scale up without triggering splits"
+ },
+ "softAllowedMaximumThroughput": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousBackupRestoreLocation",
+ "properties": {
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the continuous backup restore location."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupInformation",
+ "properties": {
+ "continuousBackupInformation": {
+ "type": {
+ "$ref": "#/643"
+ },
+ "flags": 2,
+ "description": "Information about the status of continuous backups."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousBackupInformation",
+ "properties": {
+ "latestRestorableTimestamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The latest restorable timestamp for a resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/642"
+ },
+ "input": {
+ "$ref": "#/641"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/642"
+ },
+ "input": {
+ "$ref": "#/641"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/tables",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/642"
+ },
+ "input": {
+ "$ref": "#/641"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/633"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/642"
+ },
+ "input": {
+ "$ref": "#/641"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandPostBody",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The command which should be run"
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/663"
+ },
+ "flags": 0,
+ "description": "The arguments for the command to be run"
+ },
+ "host": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "IP address of the cassandra host to run the command on"
+ },
+ "cassandra-stop-start": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "If true, stops cassandra before executing the command and then start it again"
+ },
+ "readwrite": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandPostBodyArguments",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "invokeCommand",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-04-15",
+ "input": {
+ "$ref": "#/662"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deallocate",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-04-15"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-04-15"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NotebookWorkspaceConnectionInfoResult",
+ "properties": {
+ "authToken": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Specifies auth token used for connecting to Notebook server (uses token-based auth)."
+ },
+ "notebookServerEndpoint": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Specifies the endpoint of Notebook server."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listConnectionInfo",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "apiVersion": "2025-04-15",
+ "output": {
+ "$ref": "#/667"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateAuthToken",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "apiVersion": "2025-04-15"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "apiVersion": "2025-04-15"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/cosmos-db/microsoft.documentdb/2025-05-01-preview/types.json b/internal/azure/generated/cosmos-db/microsoft.documentdb/2025-05-01-preview/types.json
new file mode 100644
index 000000000..39de82b53
--- /dev/null
+++ b/internal/azure/generated/cosmos-db/microsoft.documentdb/2025-05-01-preview/types.json
@@ -0,0 +1,15704 @@
+[
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/chaosFaults"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/chaosFaults",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 0,
+ "description": "A request object to enable/disable the chaos fault."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ChaosFaultProperties",
+ "properties": {
+ "action": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Indicates whether what action to take for the Chaos Fault."
+ },
+ "region": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Region of the account where the Chaos Fault is to be enabled/disabled."
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Database name."
+ },
+ "containerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Container name."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A provisioning state of the Chaos Fault."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/5"
+ },
+ {
+ "$ref": "#/6"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/15"
+ },
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/chaosFaults@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/3"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/copyJobs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/copyJobs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/20"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 1,
+ "description": "The properties of a Copy Job"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CopyJobProperties",
+ "properties": {
+ "jobProperties": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 1,
+ "description": "Job Properties"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/67"
+ },
+ "flags": 2,
+ "description": "Job Status"
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Processed Count"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Total Count"
+ },
+ "lastUpdatedUtcTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Last Updated Time (ISO-8601 format)"
+ },
+ "workerCount": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "Worker count"
+ },
+ "error": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 2,
+ "description": "Error response for Faulted job"
+ },
+ "duration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Total Duration of Job"
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 0,
+ "description": "Mode of job execution"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BaseCopyJobProperties",
+ "discriminator": "jobType",
+ "baseProperties": {},
+ "elements": {
+ "AzureBlobStorageToCassandraRU": {
+ "$ref": "#/26"
+ },
+ "CassandraRUToAzureBlobStorage": {
+ "$ref": "#/36"
+ },
+ "CassandraRUToCassandraRU": {
+ "$ref": "#/40"
+ },
+ "MongoRUToMongoRU": {
+ "$ref": "#/44"
+ },
+ "MongoRUToMongoVCore": {
+ "$ref": "#/49"
+ },
+ "NoSqlRUToNoSqlRU": {
+ "$ref": "#/55"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BlobToCassandraRUCopyJobProperties",
+ "properties": {
+ "sourceDetails": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 1,
+ "description": "Azure Storage container DataStore details"
+ },
+ "destinationDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Destination Cassandra DataStore details"
+ },
+ "tasks": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 1,
+ "description": "Copy Job tasks."
+ },
+ "jobType": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 1,
+ "description": "Copy Job Type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBlobSourceSinkDetails",
+ "properties": {
+ "endpointUrl": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 1,
+ "description": "Azure Blob container endpoint."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^https?://[^/$.?# ]+.[^ ]*$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosDBSourceSinkDetails",
+ "properties": {
+ "remoteAccountName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of remote account in case of cross-account data transfer."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BlobToCassandraRUCopyJobTask",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 1,
+ "description": "Source Azure Blob container"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 1,
+ "description": "Destination Cassandra table"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Total Count."
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Processed Count."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBlobContainer",
+ "properties": {
+ "containerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Blob container."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosDBCassandraTable",
+ "properties": {
+ "keyspaceName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for Apache Cassandra keyspace."
+ },
+ "tableName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for Apache Cassandra table."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/30"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBlobStorageToCassandraRU"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraRUToBlobCopyJobProperties",
+ "properties": {
+ "sourceDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Source Cassandra DataStore details"
+ },
+ "destinationDetails": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 1,
+ "description": "Destination Cassandra DataStore details"
+ },
+ "tasks": {
+ "type": {
+ "$ref": "#/38"
+ },
+ "flags": 1,
+ "description": "Copy Job tasks."
+ },
+ "jobType": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 1,
+ "description": "Copy Job Type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraRUToBlobCopyJobTask",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 1,
+ "description": "Source Cassandra table"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 1,
+ "description": "Destination Azure Blob container"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Total Count."
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Processed Count."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/37"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CassandraRUToAzureBlobStorage"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraRUToCassandraRUCopyJobProperties",
+ "properties": {
+ "sourceDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Source Cassandra DataStore details"
+ },
+ "destinationDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Destination Cassandra DataStore details"
+ },
+ "tasks": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 1,
+ "description": "Copy Job tasks."
+ },
+ "jobType": {
+ "type": {
+ "$ref": "#/43"
+ },
+ "flags": 1,
+ "description": "Copy Job Type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraRUToCassandraRUCopyJobTask",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 1,
+ "description": "Source Cassandra table"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 1,
+ "description": "Destination Cassandra table"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Total Count."
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Processed Count."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/41"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CassandraRUToCassandraRU"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoRUToMongoRUCopyJobProperties",
+ "properties": {
+ "sourceDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Source Mongo DataStore details"
+ },
+ "destinationDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Destination Mongo DataStore details"
+ },
+ "tasks": {
+ "type": {
+ "$ref": "#/47"
+ },
+ "flags": 1,
+ "description": "Copy Job tasks."
+ },
+ "jobType": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 1,
+ "description": "Copy Job Type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoRUToMongoRUCopyJobTask",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 1,
+ "description": "Source Mongo (RU) collection"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 1,
+ "description": "Destination Mongo (RU) collection"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Total Count."
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Processed Count."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosDBMongoCollection",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for MongoDB (RU) database."
+ },
+ "collectionName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for MongoDB (RU) collection."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/45"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoRUToMongoRU"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoRUToMongoVCoreCopyJobProperties",
+ "properties": {
+ "sourceDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Source Mongo (RU) DataStore details"
+ },
+ "destinationDetails": {
+ "type": {
+ "$ref": "#/50"
+ },
+ "flags": 1,
+ "description": "Destination Mongo (vCore) DataStore details"
+ },
+ "tasks": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 1,
+ "description": "Copy Job tasks."
+ },
+ "jobType": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 1,
+ "description": "Copy Job Type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoVCoreSourceSinkDetails",
+ "properties": {
+ "hostName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "connectionStringKeyVaultUri": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "URI of Azure KeyVault secret containing connection string."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoRUToMongoVCoreCopyJobTask",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 1,
+ "description": "Source Mongo (RU) collection"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 1,
+ "description": "Destination Mongo (vCore) collection"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Total Count."
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Processed Count."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosDBMongoVCoreCollection",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for MongoDB (vCore) database."
+ },
+ "collectionName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for MongoDB (vCore) collection."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/51"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoRUToMongoVCore"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NoSqlRUToNoSqlRUCopyJobProperties",
+ "properties": {
+ "sourceDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Source SQL DataStore details"
+ },
+ "destinationDetails": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Destination SQL DataStore details"
+ },
+ "tasks": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 1,
+ "description": "Copy Job tasks."
+ },
+ "jobType": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 1,
+ "description": "Copy Job Type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NoSqlRUToNoSqlRUCopyJobTask",
+ "properties": {
+ "source": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 1,
+ "description": "Source SQL container"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 1,
+ "description": "Destination SQL container"
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Total Count."
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Task level Processed Count."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosDBNoSqlContainer",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for NoSQL database."
+ },
+ "containerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Azure Cosmos DB for NoSQL container."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/56"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoSqlRUToNoSqlRU"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Partitioning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Paused"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Faulted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cancelled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/65"
+ },
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ErrorResponseAutoGenerated",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Error code."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Error message indicating why the operation failed."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Offline"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/70"
+ },
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/copyJobs@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/23"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 50,
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/76"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Indicates the type of database account. This can only be set at database account creation."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/82"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB database accounts."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "The system meta data relating to this resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GlobalDocumentDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Parse"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties",
+ "properties": {
+ "consistencyPolicy": {
+ "type": {
+ "$ref": "#/83"
+ },
+ "flags": 0,
+ "description": "The consistency policy for the Cosmos DB account."
+ },
+ "locations": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 1,
+ "description": "An array that contains the georeplication locations enabled for the Cosmos DB account."
+ },
+ "databaseAccountOfferType": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 1,
+ "description": "The offer type for the database"
+ },
+ "ipRules": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 0,
+ "description": "List of IpRules."
+ },
+ "isVirtualNetworkFilterEnabled": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules."
+ },
+ "enableAutomaticFailover": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account."
+ },
+ "capabilities": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "List of Cosmos DB capabilities for the account"
+ },
+ "virtualNetworkRules": {
+ "type": {
+ "$ref": "#/101"
+ },
+ "flags": 0,
+ "description": "List of Virtual Network ACL rules configured for the Cosmos DB account."
+ },
+ "enableMultipleWriteLocations": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Enables the account to write in multiple locations"
+ },
+ "enableCassandraConnector": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Enables the cassandra connector on the Cosmos DB C* account"
+ },
+ "connectorOffer": {
+ "type": {
+ "$ref": "#/103"
+ },
+ "flags": 0,
+ "description": "The cassandra connector offer type for the Cosmos DB database C* account."
+ },
+ "disableKeyBasedMetadataWriteAccess": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys"
+ },
+ "keyVaultKeyUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The URI of the key vault"
+ },
+ "defaultIdentity": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more."
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "Whether requests from Public Network are allowed"
+ },
+ "enableFreeTier": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether Free Tier is enabled."
+ },
+ "apiProperties": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 0,
+ "description": "API specific properties. Currently, supported only for MongoDB API."
+ },
+ "enableAnalyticalStorage": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether to enable storage analytics."
+ },
+ "analyticalStorageConfiguration": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "Analytical storage specific properties."
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of account creation."
+ },
+ "backupPolicy": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "The object representing the policy for taking backups on an account."
+ },
+ "cors": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The CORS policy for the Cosmos DB database account."
+ },
+ "networkAclBypass": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 0,
+ "description": "Indicates what services are allowed to bypass firewall checks."
+ },
+ "networkAclBypassResourceIds": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account."
+ },
+ "diagnosticLogSettings": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 0,
+ "description": "The Object representing the different Diagnostic log settings for the Cosmos DB Account."
+ },
+ "disableLocalAuth": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/158"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore."
+ },
+ "capacity": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "The object that represents all properties related to capacity enforcement on an account."
+ },
+ "capacityMode": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 0,
+ "description": "Indicates the capacityMode of the Cosmos DB account."
+ },
+ "enableMaterializedViews": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether to enable MaterializedViews on the Cosmos DB account"
+ },
+ "keysMetadata": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 2,
+ "description": "This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account."
+ },
+ "enablePartitionMerge": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account"
+ },
+ "enableBurstCapacity": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account"
+ },
+ "minimalTlsVersion": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 0,
+ "description": "Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2."
+ },
+ "customerManagedKeyStatus": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance."
+ },
+ "enablePriorityBasedExecution": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account"
+ },
+ "defaultPriorityLevel": {
+ "type": {
+ "$ref": "#/182"
+ },
+ "flags": 0,
+ "description": "Enum to indicate default Priority Level of request for Priority Based Execution."
+ },
+ "enablePerRegionPerPartitionAutoscale": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account"
+ },
+ "enableAllVersionsAndDeletesChangeFeed": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the resource."
+ },
+ "documentEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The connection endpoint for the Cosmos DB database account."
+ },
+ "writeLocations": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 2,
+ "description": "An array that contains the write location for the Cosmos DB account."
+ },
+ "readLocations": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 2,
+ "description": "An array that contains of the read locations enabled for the Cosmos DB account."
+ },
+ "failoverPolicies": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 2,
+ "description": "An array that contains the regions ordered by their failover priorities."
+ },
+ "privateEndpointConnections": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 2,
+ "description": "List of Private Endpoint Connections configured for the Cosmos DB account."
+ },
+ "instanceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A unique identifier assigned to the database account"
+ },
+ "capacityModeChangeTransitionState": {
+ "type": {
+ "$ref": "#/192"
+ },
+ "flags": 2,
+ "description": "The object that represents the migration state for the CapacityMode of the Cosmos DB account."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConsistencyPolicy",
+ "properties": {
+ "defaultConsistencyLevel": {
+ "type": {
+ "$ref": "#/89"
+ },
+ "flags": 1,
+ "description": "The default consistency level and configuration settings of the Cosmos DB account."
+ },
+ "maxStalenessPrefix": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'."
+ },
+ "maxIntervalInSeconds": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 0,
+ "description": "When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Eventual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Session"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BoundedStaleness"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Strong"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConsistentPrefix"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/88"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 2147483647
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 5,
+ "maxValue": 86400
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Location",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique identifier of the region within the database account. Example: <accountName>-<locationName>."
+ },
+ "locationName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the region."
+ },
+ "documentEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the resource."
+ },
+ "failoverPriority": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists."
+ },
+ "isZoneRedundant": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Flag to indicate whether or not this region is an AvailabilityZone region"
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/92"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IpAddressOrRange",
+ "properties": {
+ "ipAddressOrRange": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/96"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Capability",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/98"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualNetworkRule",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}."
+ },
+ "ignoreMissingVNetServiceEndpoint": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Create firewall rule before the virtual network has vnet service endpoint enabled."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/100"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Small"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecuredByPerimeter"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/105"
+ },
+ {
+ "$ref": "#/106"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApiProperties",
+ "properties": {
+ "serverVersion": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "Describes the version of the MongoDB account."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "3.2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "3.6"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "4.0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "4.2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "5.0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "6.0"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "7.0"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/109"
+ },
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/114"
+ },
+ {
+ "$ref": "#/115"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AnalyticalStorageConfiguration",
+ "properties": {
+ "schemaType": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 0,
+ "description": "Describes the types of schema for analytical storage."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WellDefined"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FullFidelity"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/121"
+ },
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BackupPolicy",
+ "discriminator": "type",
+ "baseProperties": {
+ "migrationState": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "The object representing the state of the migration between the backup policies."
+ }
+ },
+ "elements": {
+ "Continuous": {
+ "$ref": "#/134"
+ },
+ "Periodic": {
+ "$ref": "#/140"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupPolicyMigrationState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 0,
+ "description": "Describes the status of migration between backup policy types."
+ },
+ "targetType": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 0,
+ "description": "Describes the target backup policy type of the backup policy migration."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Time at which the backup policy migration started (ISO-8601 format)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/128"
+ },
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Periodic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/132"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousModeBackupPolicy",
+ "properties": {
+ "continuousModeProperties": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "Configuration values for continuous mode backup"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 1,
+ "description": "Describes the mode of backups."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousModeProperties",
+ "properties": {
+ "tier": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "Enum to indicate type of Continuos backup mode"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous7Days"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous30Days"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/137"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PeriodicModeBackupPolicy",
+ "properties": {
+ "periodicModeProperties": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "Configuration values for periodic mode backup"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 1,
+ "description": "Describes the mode of backups."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PeriodicModeProperties",
+ "properties": {
+ "backupIntervalInMinutes": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "An integer representing the interval in minutes between two backups"
+ },
+ "backupRetentionIntervalInHours": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "An integer representing the time (in hours) that each backup is retained"
+ },
+ "backupStorageRedundancy": {
+ "type": {
+ "$ref": "#/145"
+ },
+ "flags": 0,
+ "description": "Enum to indicate type of backup residency"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Geo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Local"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Zone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/144"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Periodic"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CorsPolicy",
+ "properties": {
+ "allowedOrigins": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The origin domains that are permitted to make a request against the service via CORS."
+ },
+ "allowedMethods": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request."
+ },
+ "allowedHeaders": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The request headers that the origin domain may specify on the CORS request."
+ },
+ "exposedHeaders": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer."
+ },
+ "maxAgeInSeconds": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 0,
+ "description": "The maximum amount time that a browser should cache the preflight OPTIONS request."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/147"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureServices"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiagnosticLogSettings",
+ "properties": {
+ "enableFullTextQuery": {
+ "type": {
+ "$ref": "#/157"
+ },
+ "flags": 0,
+ "description": "Describe the level of detail with which queries are to be logged."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "True"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "False"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/154"
+ },
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestoreParameters",
+ "properties": {
+ "restoreMode": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 0,
+ "description": "Describes the mode of the restore."
+ },
+ "databasesToRestore": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "List of specific databases available for restore."
+ },
+ "gremlinDatabasesToRestore": {
+ "type": {
+ "$ref": "#/166"
+ },
+ "flags": 0,
+ "description": "List of specific gremlin databases available for restore."
+ },
+ "tablesToRestore": {
+ "type": {
+ "$ref": "#/167"
+ },
+ "flags": 0,
+ "description": "List of specific tables available for restore."
+ },
+ "sourceBackupLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The source backup location for restore."
+ },
+ "restoreSource": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}"
+ },
+ "restoreTimestampInUtc": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Time to which the account has to be restored (ISO-8601 format)."
+ },
+ "restoreWithTtlDisabled": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PointInTime"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/159"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseRestoreResource",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the database available for restore."
+ },
+ "collectionNames": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "The names of the collections available for restore."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/161"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinDatabaseRestoreResource",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the gremlin database available for restore."
+ },
+ "graphNames": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "The names of the graphs available for restore."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/164"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Capacity",
+ "properties": {
+ "totalThroughputLimit": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": -1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Serverless"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountKeysMetadata",
+ "properties": {
+ "primaryMasterKey": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Primary Read-Write Key for the given Cosmos DB database account."
+ },
+ "secondaryMasterKey": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account."
+ },
+ "primaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Primary Read-Only Key for the given Cosmos DB database account."
+ },
+ "secondaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 2,
+ "description": "The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccountKeyMetadata",
+ "properties": {
+ "generationTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tls"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tls11"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tls12"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/176"
+ },
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "High"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Low"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/180"
+ },
+ {
+ "$ref": "#/181"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/92"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/92"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FailoverPolicy",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>."
+ },
+ "locationName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the region in which the database account exists."
+ },
+ "failoverPriority": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnection",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "Resource properties."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 0,
+ "description": "Private endpoint which the connection belongs to."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 0,
+ "description": "Connection State of the Private Endpoint Connection."
+ },
+ "groupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Group id of the private endpoint."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Provisioning state of the private endpoint."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointProperty",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource id of the private endpoint."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionStateProperty",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The private link service connection status."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The private link service connection description."
+ },
+ "actionsRequired": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/187"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CapacityModeChangeTransitionState",
+ "properties": {
+ "capacityModeTransitionStatus": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 0,
+ "description": "The transition status of capacity mode."
+ },
+ "currentCapacityMode": {
+ "type": {
+ "$ref": "#/202"
+ },
+ "flags": 0,
+ "description": "Indicates the current capacity mode of the account."
+ },
+ "previousCapacityMode": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "Indicates the previous capacity mode of the account before successful transition."
+ },
+ "capacityModeTransitionBeginTimestamp": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Begin time in UTC of the capacity mode change."
+ },
+ "capacityModeTransitionEndTimestamp": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "End time in UTC of the capacity mode change."
+ },
+ "capacityModeLastSuccessfulTransitionEndTimestamp": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "End time in UTC of the last successful capacity mode change."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/193"
+ },
+ {
+ "$ref": "#/194"
+ },
+ {
+ "$ref": "#/195"
+ },
+ {
+ "$ref": "#/196"
+ },
+ {
+ "$ref": "#/197"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Serverless"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/199"
+ },
+ {
+ "$ref": "#/200"
+ },
+ {
+ "$ref": "#/201"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Serverless"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/203"
+ },
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/213"
+ },
+ "flags": 0,
+ "description": "The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 0,
+ "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned,UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/211"
+ },
+ {
+ "$ref": "#/212"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/214"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/77"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/graphs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/graphs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/220"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Graph resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/224"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GraphResourceCreateUpdatePropertiesOrGraphResourceGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Graph resource"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/222"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GraphResourceOrGraphResourceGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Graph"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrGraphResourceGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoscaleSettings",
+ "properties": {
+ "maxThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Represents maximum throughput, the resource can scale up to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/graphs@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/219"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB SQL database."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a SQL database"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL database"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_colls": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property that specified the addressable path of the collections resource."
+ },
+ "_users": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property that specifies the addressable path of the users resource."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceRestoreParameters",
+ "properties": {
+ "restoreSource": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}"
+ },
+ "restoreTimestampInUtc": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Time to which the account has to be restored (ISO-8601 format)."
+ },
+ "restoreWithTtlDisabled": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/232"
+ },
+ {
+ "$ref": "#/233"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/228"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/240"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/249"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a resource throughput"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 0,
+ "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "minimumThroughput": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The minimum throughput of the resource"
+ },
+ "offerReplacePending": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The throughput replace is pending"
+ },
+ "instantMaximumThroughput": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The offer throughput value to instantly scale up without triggering splits"
+ },
+ "softAllowedMaximumThroughput": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified"
+ },
+ "throughputBuckets": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "Array of Throughput Bucket limits to be applied to the Cosmos DB container"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoscaleSettingsResource",
+ "properties": {
+ "maxThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "Represents maximum throughput container can scale up to."
+ },
+ "autoUpgradePolicy": {
+ "type": {
+ "$ref": "#/245"
+ },
+ "flags": 0,
+ "description": "Cosmos DB resource auto-upgrade policy"
+ },
+ "targetMaxThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Represents target maximum throughput container can scale up to once offer is no longer in pending state."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutoUpgradePolicyResource",
+ "properties": {
+ "throughputPolicy": {
+ "type": {
+ "$ref": "#/246"
+ },
+ "flags": 0,
+ "description": "Represents throughput policy which service must adhere to for auto-upgrade"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputPolicyResource",
+ "properties": {
+ "isEnabled": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Determines whether the ThroughputPolicy is active or not"
+ },
+ "incrementPercent": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Represents the percentage by which throughput can increase every time throughput policy kicks in."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputBucketResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "Represents the throughput bucket id"
+ },
+ "maxThroughputPercentage": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "Represents maximum percentage throughput that can be used by the bucket"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/247"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/241"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/251"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/254"
+ },
+ "flags": 1,
+ "description": "Properties to create and update ClientEncryptionKey."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a ClientEncryptionKey"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the ClientEncryptionKey"
+ },
+ "encryptionAlgorithm": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data."
+ },
+ "wrappedDataEncryptionKey": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 0,
+ "description": "Wrapped (encrypted) form of the key represented as a byte array."
+ },
+ "keyWrapMetadata": {
+ "type": {
+ "$ref": "#/257"
+ },
+ "flags": 0,
+ "description": "Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyWrapMetadata",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of associated KeyEncryptionKey (aka CustomerManagedKey)."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "ProviderName of KeyStoreProvider."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Reference / link to the KeyEncryptionKey."
+ },
+ "algorithm": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Algorithm used in wrapping and unwrapping of the data encryption key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/253"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB container."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a container"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/346"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlContainerResourceOrSqlContainerGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL container"
+ },
+ "indexingPolicy": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 0,
+ "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container"
+ },
+ "partitionKey": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 0,
+ "description": "The configuration of the partition key to be used for partitioning data into multiple partitions"
+ },
+ "defaultTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Default time to live"
+ },
+ "uniqueKeyPolicy": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service."
+ },
+ "conflictResolutionPolicy": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 0,
+ "description": "The conflict resolution policy for the container."
+ },
+ "clientEncryptionPolicy": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 0,
+ "description": "The client encryption policy for the container."
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "materializedViewDefinition": {
+ "type": {
+ "$ref": "#/327"
+ },
+ "flags": 0,
+ "description": "The configuration for defining Materialized Views. This must be specified only for creating a Materialized View container."
+ },
+ "materializedViews": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 0,
+ "description": "Materialized Views defined on the container."
+ },
+ "computedProperties": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 0,
+ "description": "List of computed properties"
+ },
+ "vectorEmbeddingPolicy": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 0,
+ "description": "The vector embedding policy for the container."
+ },
+ "fullTextPolicy": {
+ "type": {
+ "$ref": "#/343"
+ },
+ "flags": 0,
+ "description": "The FullText policy for the container."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IndexingPolicy",
+ "properties": {
+ "automatic": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Indicates if the indexing policy is automatic"
+ },
+ "indexingMode": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 0,
+ "description": "Indicates the indexing mode."
+ },
+ "includedPaths": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 0,
+ "description": "List of paths to include in the indexing"
+ },
+ "excludedPaths": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 0,
+ "description": "List of paths to exclude from indexing"
+ },
+ "compositeIndexes": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "List of composite path list"
+ },
+ "spatialIndexes": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 0,
+ "description": "List of spatial specifics"
+ },
+ "vectorIndexes": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 0,
+ "description": "List of paths to include in the vector indexing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "consistent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "lazy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/267"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IncludedPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ },
+ "indexes": {
+ "type": {
+ "$ref": "#/282"
+ },
+ "flags": 0,
+ "description": "List of indexes for this path"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Indexes",
+ "properties": {
+ "dataType": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 0,
+ "description": "The datatype for which the indexing behavior is applied to."
+ },
+ "precision": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "The precision of the index. -1 is maximum precision."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 0,
+ "description": "Indicates the type of index."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Number"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Point"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Polygon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LineString"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiPolygon"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/272"
+ },
+ {
+ "$ref": "#/273"
+ },
+ {
+ "$ref": "#/274"
+ },
+ {
+ "$ref": "#/275"
+ },
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hash"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Range"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Spatial"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/270"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/269"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExcludedPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/284"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CompositePath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ },
+ "order": {
+ "type": {
+ "$ref": "#/289"
+ },
+ "flags": 0,
+ "description": "Sort order for composite paths."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ascending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "descending"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/287"
+ },
+ {
+ "$ref": "#/288"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/286"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/290"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SpatialSpec",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)"
+ },
+ "types": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 0,
+ "description": "List of path's spatial type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Point"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LineString"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Polygon"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiPolygon"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/296"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/297"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/292"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VectorIndex",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The path to the vector field in the document."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 1,
+ "description": "The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "flat"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "diskANN"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "quantizedFlat"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/301"
+ },
+ {
+ "$ref": "#/302"
+ },
+ {
+ "$ref": "#/303"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/300"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContainerPartitionKey",
+ "properties": {
+ "paths": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "List of paths using which data within the container can be partitioned"
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 0,
+ "description": "Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create"
+ },
+ "version": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 0,
+ "description": "Indicates the version of the partition key definition"
+ },
+ "systemKey": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Indicates if the container is using a system generated partition key"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hash"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Range"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiHash"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/308"
+ },
+ {
+ "$ref": "#/309"
+ },
+ {
+ "$ref": "#/310"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UniqueKeyPolicy",
+ "properties": {
+ "uniqueKeys": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 0,
+ "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UniqueKey",
+ "properties": {
+ "paths": {
+ "type": {
+ "$ref": "#/315"
+ },
+ "flags": 0,
+ "description": "List of paths must be unique for each document in the Azure Cosmos DB service"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/314"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConflictResolutionPolicy",
+ "properties": {
+ "mode": {
+ "type": {
+ "$ref": "#/320"
+ },
+ "flags": 0,
+ "description": "Indicates the conflict resolution mode."
+ },
+ "conflictResolutionPath": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The conflict resolution path in the case of LastWriterWins mode."
+ },
+ "conflictResolutionProcedure": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The procedure to resolve conflicts in the case of custom mode."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LastWriterWins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/318"
+ },
+ {
+ "$ref": "#/319"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionPolicy",
+ "properties": {
+ "includedPaths": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 1,
+ "description": "Paths of the item that need encryption along with path-specific settings."
+ },
+ "policyFormatVersion": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 1,
+ "description": "Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClientEncryptionIncludedPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Path that needs to be encrypted."
+ },
+ "clientEncryptionKeyId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The identifier of the Client Encryption Key to be used to encrypt the path."
+ },
+ "encryptionType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The type of encryption to be performed. Eg - Deterministic, Randomized."
+ },
+ "encryptionAlgorithm": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/322"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/324"
+ },
+ {
+ "$ref": "#/325"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaterializedViewDefinition",
+ "properties": {
+ "sourceCollectionRid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "An unique identifier for the source collection. This is a system generated property."
+ },
+ "sourceCollectionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The name of the source container on which the Materialized View will be created."
+ },
+ "definition": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The definition should be an SQL query which would be used to fetch data from the source container to populate into the Materialized View container."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaterializedViewDetails",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Id field of Materialized container."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "_rid field of Materialized container."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/328"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ComputedProperty",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of a computed property, for example - \"cp_lowerName\""
+ },
+ "query": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The query that evaluates the value for computed property, for example - \"SELECT VALUE LOWER(c.name) FROM c\""
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/330"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VectorEmbeddingPolicy",
+ "properties": {
+ "vectorEmbeddings": {
+ "type": {
+ "$ref": "#/342"
+ },
+ "flags": 0,
+ "description": "List of vector embeddings"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VectorEmbedding",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The path to the vector field in the document."
+ },
+ "dataType": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 1,
+ "description": "Indicates the data type of vector."
+ },
+ "distanceFunction": {
+ "type": {
+ "$ref": "#/341"
+ },
+ "flags": 1,
+ "description": "The distance function to use for distance calculation in between vectors."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 1,
+ "description": "The number of dimensions in the vector."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "float32"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "uint8"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "int8"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/335"
+ },
+ {
+ "$ref": "#/336"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "euclidean"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cosine"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "dotproduct"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/333"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FullTextPolicy",
+ "properties": {
+ "defaultLanguage": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The default language for a full text paths."
+ },
+ "fullTextPaths": {
+ "type": {
+ "$ref": "#/345"
+ },
+ "flags": 0,
+ "description": "List of FullText Paths"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FullTextPath",
+ "properties": {
+ "path": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The path to the full text field in the document."
+ },
+ "language": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The language of the full text field in the document."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/344"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrSqlContainerGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/261"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/349"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/350"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/351"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/353"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/352"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/355"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/358"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB storedProcedure."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlStoredProcedureCreateUpdatePropertiesOrSqlStoredProcedureGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/359"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a storedProcedure"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 4,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlStoredProcedureResourceOrSqlStoredProcedureGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL storedProcedure"
+ },
+ "body": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Body of the Stored Procedure"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/357"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/363"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/366"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB userDefinedFunction."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/368"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a userDefinedFunction"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 4,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL userDefinedFunction"
+ },
+ "body": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Body of the User Defined Function"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/365"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/371"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB trigger."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/384"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlTriggerCreateUpdatePropertiesOrSqlTriggerGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/374"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a trigger"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 4,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlTriggerResourceOrSqlTriggerGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB SQL trigger"
+ },
+ "body": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Body of the Trigger"
+ },
+ "triggerType": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 0,
+ "description": "Type of the Trigger"
+ },
+ "triggerOperation": {
+ "type": {
+ "$ref": "#/383"
+ },
+ "flags": 0,
+ "description": "The operation the trigger is associated with"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pre"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Post"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/376"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "All"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Create"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Update"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replace"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/382"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/372"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/386"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/387"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/389"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB SQL Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlRoleDefinitionResource",
+ "properties": {
+ "roleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/392"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "assignableScopes": {
+ "type": {
+ "$ref": "#/393"
+ },
+ "flags": 0,
+ "description": "A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist."
+ },
+ "permissions": {
+ "type": {
+ "$ref": "#/397"
+ },
+ "flags": 0,
+ "description": "The set of operations allowed through this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/390"
+ },
+ {
+ "$ref": "#/391"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Permission",
+ "properties": {
+ "dataActions": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are allowed."
+ },
+ "notDataActions": {
+ "type": {
+ "$ref": "#/396"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are denied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/394"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/388"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/399"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/400"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/402"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB SQL Role Assignment."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlRoleAssignmentResource",
+ "properties": {
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated Role Definition."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The data plane resource path for which access is being granted through this Role Assignment."
+ },
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/401"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/405"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB MongoDB database."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/413"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDatabaseGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/408"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a MongoDB database"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB MongoDB database"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/409"
+ },
+ {
+ "$ref": "#/410"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/406"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/415"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/416"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/418"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/421"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/422"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/424"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB MongoDB collection."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/425"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a MongoDB collection"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/435"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB MongoDB collection"
+ },
+ "shardKey": {
+ "type": {
+ "$ref": "#/426"
+ },
+ "flags": 0,
+ "description": "A key-value pair of shard keys to be applied for the request."
+ },
+ "indexes": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 0,
+ "description": "List of index keys"
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/434"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ShardKeys",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoIndex",
+ "properties": {
+ "key": {
+ "type": {
+ "$ref": "#/428"
+ },
+ "flags": 0,
+ "description": "Cosmos DB MongoDB collection index keys"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 0,
+ "description": "Cosmos DB MongoDB collection index key options"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoIndexKeys",
+ "properties": {
+ "keys": {
+ "type": {
+ "$ref": "#/429"
+ },
+ "flags": 0,
+ "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoIndexOptions",
+ "properties": {
+ "expireAfterSeconds": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Expire after seconds"
+ },
+ "unique": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Is unique or not"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/427"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/423"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/438"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/439"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/442"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/441"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/447"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Mongo Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoRoleDefinitionResource",
+ "properties": {
+ "roleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/450"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The database name for which access is being granted for this Role Definition."
+ },
+ "privileges": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 0,
+ "description": "A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/456"
+ },
+ "flags": 0,
+ "description": "The set of roles inherited by this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/448"
+ },
+ {
+ "$ref": "#/449"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Privilege",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/452"
+ },
+ "flags": 0,
+ "description": "An Azure Cosmos DB Mongo DB Resource."
+ },
+ "actions": {
+ "type": {
+ "$ref": "#/453"
+ },
+ "flags": 0,
+ "description": "An array of actions that are allowed."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivilegeResource",
+ "properties": {
+ "db": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The database name the role is applied."
+ },
+ "collection": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The collection name the role is applied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/451"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Role",
+ "properties": {
+ "db": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The database name the role is applied."
+ },
+ "role": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The role name."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/455"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/446"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/458"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Mongo User Definition."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoUserDefinitionResource",
+ "properties": {
+ "userName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The user name for User Definition."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The password for User Definition. Response does not contain user password."
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The database name for which access is being granted for this User Definition."
+ },
+ "customData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A custom definition for the USer Definition."
+ },
+ "roles": {
+ "type": {
+ "$ref": "#/462"
+ },
+ "flags": 0,
+ "description": "The set of roles inherited by the User Definition."
+ },
+ "mechanisms": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/455"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/460"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/tables"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/464"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/465"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/467"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Table."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TableCreateUpdatePropertiesOrTableGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/468"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Table"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/472"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TableResourceOrTableGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB table"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/471"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/469"
+ },
+ {
+ "$ref": "#/470"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrTableGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/466"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/475"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/476"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/477"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/479"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/478"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/tableRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tableRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/481"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/482"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/484"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Table Role Definition."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TableRoleDefinitionResourceProperties",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path id for the Role Definition."
+ },
+ "roleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/487"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "assignableScopes": {
+ "type": {
+ "$ref": "#/488"
+ },
+ "flags": 0,
+ "description": "A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist."
+ },
+ "permissions": {
+ "type": {
+ "$ref": "#/492"
+ },
+ "flags": 0,
+ "description": "The set of operations allowed through this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/485"
+ },
+ {
+ "$ref": "#/486"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PermissionAutoGenerated",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The id for the permission."
+ },
+ "dataActions": {
+ "type": {
+ "$ref": "#/490"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are allowed."
+ },
+ "notDataActions": {
+ "type": {
+ "$ref": "#/491"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are denied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/489"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tableRoleDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/483"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/494"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/495"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/497"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Table Role Assignment."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TableRoleAssignmentResourceProperties",
+ "properties": {
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated Role Definition."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The data plane resource path for which access is being granted through this Table Role Assignment."
+ },
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Table Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/496"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/499"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/500"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/502"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/505"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/503"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Cassandra keyspace"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/504"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Cassandra keyspace"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/501"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/507"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/508"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/509"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/511"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/510"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/513"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/514"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/516"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Cassandra table."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/526"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/517"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Cassandra table"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/525"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraTableResourceOrCassandraTableGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Cassandra table"
+ },
+ "defaultTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Time to live of the Cosmos DB Cassandra table"
+ },
+ "schema": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "Schema of the Cosmos DB Cassandra table"
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraSchema",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/520"
+ },
+ "flags": 0,
+ "description": "List of Cassandra table columns."
+ },
+ "partitionKeys": {
+ "type": {
+ "$ref": "#/522"
+ },
+ "flags": 0,
+ "description": "List of partition key."
+ },
+ "clusterKeys": {
+ "type": {
+ "$ref": "#/524"
+ },
+ "flags": 0,
+ "description": "List of cluster key."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Column",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB Cassandra table column"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Type of the Cosmos DB Cassandra table column"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/519"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraPartitionKey",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB Cassandra table partition key"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/521"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterKey",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the Cosmos DB Cassandra table cluster key"
+ },
+ "orderBy": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\""
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/523"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrCassandraTableGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/515"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/528"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/529"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/530"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/532"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/531"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/534"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/535"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/537"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Cassandra view."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/540"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/538"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Cassandra view"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/539"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraViewResourceOrCassandraViewGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Cassandra view"
+ },
+ "viewDefinition": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "View Definition of the Cosmos DB Cassandra view"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrCassandraViewGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/536"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/542"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/543"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/544"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/546"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/545"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/548"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/549"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/551"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Cassandra Role Definition."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraRoleDefinitionResourceProperties",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path id for the Role Definition."
+ },
+ "roleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/554"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "assignableScopes": {
+ "type": {
+ "$ref": "#/555"
+ },
+ "flags": 0,
+ "description": "A set of fully qualified Scopes at or below which Cassandra Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist."
+ },
+ "permissions": {
+ "type": {
+ "$ref": "#/559"
+ },
+ "flags": 0,
+ "description": "The set of operations allowed through this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/552"
+ },
+ {
+ "$ref": "#/553"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PermissionAutoGenerated2",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The id for the permission."
+ },
+ "dataActions": {
+ "type": {
+ "$ref": "#/557"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are allowed."
+ },
+ "notDataActions": {
+ "type": {
+ "$ref": "#/558"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are denied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/556"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraRoleDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/550"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/cassandraRoleAssignments"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraRoleAssignments",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/561"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/562"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/564"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Cassandra Role Assignment."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraRoleAssignmentResourceProperties",
+ "properties": {
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated Role Definition."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The data plane resource path for which access is being granted through this Cassandra Role Assignment."
+ },
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Cassandra Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/cassandraRoleAssignments@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/563"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/566"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/567"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/569"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Gremlin database."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/575"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/570"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Gremlin database"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/574"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Gremlin database"
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/573"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/571"
+ },
+ {
+ "$ref": "#/572"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/568"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/577"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/578"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/579"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/581"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/580"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/583"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/584"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/586"
+ },
+ "flags": 1,
+ "description": "Properties to create and update Azure Cosmos DB Gremlin graph."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/592"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/587"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a Gremlin graph"
+ },
+ "options": {
+ "type": {
+ "$ref": "#/591"
+ },
+ "flags": 0,
+ "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinGraphResourceOrGremlinGraphGetPropertiesResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Cosmos DB Gremlin graph"
+ },
+ "indexingPolicy": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 0,
+ "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph"
+ },
+ "partitionKey": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 0,
+ "description": "The configuration of the partition key to be used for partitioning data into multiple partitions"
+ },
+ "defaultTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Default time to live"
+ },
+ "uniqueKeyPolicy": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service."
+ },
+ "conflictResolutionPolicy": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 0,
+ "description": "The conflict resolution policy for the graph."
+ },
+ "analyticalStorageTtl": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Analytical TTL."
+ },
+ "restoreParameters": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Parameters to indicate the information about the restore"
+ },
+ "createMode": {
+ "type": {
+ "$ref": "#/590"
+ },
+ "flags": 0,
+ "description": "Enum to indicate the mode of resource creation."
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/588"
+ },
+ {
+ "$ref": "#/589"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Request Units per second. For example, \"throughput\": 10000."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/585"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/594"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/595"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/596"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/242"
+ },
+ "flags": 1,
+ "description": "Properties to update Azure Cosmos DB resource throughput."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/598"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/597"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/600"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/601"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/603"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Gremlin Role Definition."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinRoleDefinitionResourceProperties",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path id for the Role Definition."
+ },
+ "roleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/606"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "assignableScopes": {
+ "type": {
+ "$ref": "#/607"
+ },
+ "flags": 0,
+ "description": "A set of fully qualified Scopes at or below which Gremlin Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist."
+ },
+ "permissions": {
+ "type": {
+ "$ref": "#/611"
+ },
+ "flags": 0,
+ "description": "The set of operations allowed through this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/604"
+ },
+ {
+ "$ref": "#/605"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PermissionAutoGenerated4",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The id for the permission."
+ },
+ "dataActions": {
+ "type": {
+ "$ref": "#/609"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are allowed."
+ },
+ "notDataActions": {
+ "type": {
+ "$ref": "#/610"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are denied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/608"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/602"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleAssignments"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleAssignments",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/613"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/614"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/616"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB Gremlin Role Assignment."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GremlinRoleAssignmentResourceProperties",
+ "properties": {
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated Role Definition."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The data plane resource path for which access is being granted through this Gremlin Role Assignment."
+ },
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleAssignments@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/615"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/618"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/619"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/621"
+ },
+ "flags": 1,
+ "description": "Data Transfer Create Job Properties"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataTransferJobProperties",
+ "properties": {
+ "jobName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Job Name"
+ },
+ "source": {
+ "type": {
+ "$ref": "#/622"
+ },
+ "flags": 1,
+ "description": "Source DataStore details"
+ },
+ "destination": {
+ "type": {
+ "$ref": "#/622"
+ },
+ "flags": 1,
+ "description": "Destination DataStore details"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Job Status"
+ },
+ "processedCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Processed Count."
+ },
+ "totalCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "Total Count."
+ },
+ "lastUpdatedUtcTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Last Updated Time (ISO-8601 format)."
+ },
+ "workerCount": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "Worker count"
+ },
+ "error": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 2,
+ "description": "Error response for Faulted job"
+ },
+ "duration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Total Duration of Job"
+ },
+ "mode": {
+ "type": {
+ "$ref": "#/635"
+ },
+ "flags": 0,
+ "description": "Mode of job execution"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "DataTransferDataSourceSink",
+ "discriminator": "component",
+ "baseProperties": {},
+ "elements": {
+ "AzureBlobStorage": {
+ "$ref": "#/623"
+ },
+ "CosmosDBCassandra": {
+ "$ref": "#/625"
+ },
+ "CosmosDBMongo": {
+ "$ref": "#/627"
+ },
+ "CosmosDBSql": {
+ "$ref": "#/629"
+ },
+ "CosmosDBMongoVCore": {
+ "$ref": "#/631"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBlobDataTransferDataSourceSink",
+ "properties": {
+ "containerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "endpointUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "component": {
+ "type": {
+ "$ref": "#/624"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBlobStorage"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosCassandraDataTransferDataSourceSink",
+ "properties": {
+ "keyspaceName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "tableName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "remoteAccountName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "component": {
+ "type": {
+ "$ref": "#/626"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CosmosDBCassandra"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosMongoDataTransferDataSourceSink",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "collectionName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "remoteAccountName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "component": {
+ "type": {
+ "$ref": "#/628"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CosmosDBMongo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosSqlDataTransferDataSourceSink",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "containerName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "remoteAccountName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "component": {
+ "type": {
+ "$ref": "#/630"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CosmosDBSql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CosmosMongoVCoreDataTransferDataSourceSink",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "collectionName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "hostName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "connectionStringKeyVaultUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "component": {
+ "type": {
+ "$ref": "#/632"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CosmosDBMongoVCore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Offline"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/633"
+ },
+ {
+ "$ref": "#/634"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/620"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 100,
+ "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/cassandraClusters"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/cassandraClusters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/637"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/638"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/639"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/641"
+ },
+ "flags": 0,
+ "description": "Properties of a managed Cassandra cluster."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/680"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/681"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ClusterResourceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/648"
+ },
+ "flags": 0,
+ "description": "The status of the resource at the time the operation was called."
+ },
+ "restoreFromBackupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 4,
+ "description": "To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup."
+ },
+ "delegatedManagementSubnetId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'"
+ },
+ "cassandraVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version."
+ },
+ "clusterNameOverride": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property."
+ },
+ "authenticationMethod": {
+ "type": {
+ "$ref": "#/652"
+ },
+ "flags": 0,
+ "description": "Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'."
+ },
+ "initialCassandraAdminPassword": {
+ "type": {
+ "$ref": "#/653"
+ },
+ "flags": 4,
+ "description": "Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'."
+ },
+ "prometheusEndpoint": {
+ "type": {
+ "$ref": "#/654"
+ },
+ "flags": 0,
+ "description": "Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached."
+ },
+ "repairEnabled": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs."
+ },
+ "autoReplicate": {
+ "type": {
+ "$ref": "#/658"
+ },
+ "flags": 0,
+ "description": "The form of AutoReplicate that is being used by this cluster."
+ },
+ "clientCertificates": {
+ "type": {
+ "$ref": "#/660"
+ },
+ "flags": 0,
+ "description": "List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property."
+ },
+ "externalGossipCertificates": {
+ "type": {
+ "$ref": "#/661"
+ },
+ "flags": 0,
+ "description": "List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property."
+ },
+ "gossipCertificates": {
+ "type": {
+ "$ref": "#/662"
+ },
+ "flags": 2,
+ "description": "List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property."
+ },
+ "externalSeedNodes": {
+ "type": {
+ "$ref": "#/663"
+ },
+ "flags": 0,
+ "description": "List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes."
+ },
+ "seedNodes": {
+ "type": {
+ "$ref": "#/664"
+ },
+ "flags": 2,
+ "description": "List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes."
+ },
+ "externalDataCenters": {
+ "type": {
+ "$ref": "#/665"
+ },
+ "flags": 0,
+ "description": "List of the data center names for unmanaged data centers in this cluster to be included in auto-replication."
+ },
+ "hoursBetweenBackups": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "(Deprecated) Number of hours to wait between taking a backup of the cluster."
+ },
+ "deallocated": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Whether the cluster and associated data centers has been deallocated."
+ },
+ "cassandraAuditLoggingEnabled": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Whether Cassandra audit logging is enabled"
+ },
+ "clusterType": {
+ "type": {
+ "$ref": "#/668"
+ },
+ "flags": 0,
+ "description": "Type of the cluster. If set to Production, some operations might not be permitted on cluster."
+ },
+ "provisionError": {
+ "type": {
+ "$ref": "#/669"
+ },
+ "flags": 0,
+ "description": "Error related to resource provisioning."
+ },
+ "extensions": {
+ "type": {
+ "$ref": "#/670"
+ },
+ "flags": 0,
+ "description": "Extensions to be added or updated on cluster."
+ },
+ "backupSchedules": {
+ "type": {
+ "$ref": "#/672"
+ },
+ "flags": 0,
+ "description": "List of backup schedules that define when you want to back up your data."
+ },
+ "scheduledEventStrategy": {
+ "type": {
+ "$ref": "#/676"
+ },
+ "flags": 0,
+ "description": "How the nodes in the cluster react to scheduled events"
+ },
+ "azureConnectionMethod": {
+ "type": {
+ "$ref": "#/679"
+ },
+ "flags": 0,
+ "description": "How to connect to the azure services needed for running the cluster"
+ },
+ "privateLinkResourceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/642"
+ },
+ {
+ "$ref": "#/643"
+ },
+ {
+ "$ref": "#/644"
+ },
+ {
+ "$ref": "#/645"
+ },
+ {
+ "$ref": "#/646"
+ },
+ {
+ "$ref": "#/647"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cassandra"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ldap"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/649"
+ },
+ {
+ "$ref": "#/650"
+ },
+ {
+ "$ref": "#/651"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SeedNode",
+ "properties": {
+ "ipAddress": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "IP address of this seed node."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemKeyspaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllKeyspaces"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/655"
+ },
+ {
+ "$ref": "#/656"
+ },
+ {
+ "$ref": "#/657"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Certificate",
+ "properties": {
+ "pem": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "PEM formatted public key."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/659"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/659"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/659"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/654"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/654"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Production"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NonProduction"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/666"
+ },
+ {
+ "$ref": "#/667"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CassandraError",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The code of error that occurred."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The message of the error."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The target resource of the error."
+ },
+ "additionalErrorInfo": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Additional information about the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupSchedule",
+ "properties": {
+ "scheduleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier of backup schedule."
+ },
+ "cronExpression": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The cron expression that defines when you want to back up your data."
+ },
+ "retentionInHours": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "The retention period (hours) of the backups. If you want to retain data forever, set retention to 0."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/671"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ignore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StopAny"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StopByRack"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/673"
+ },
+ {
+ "$ref": "#/674"
+ },
+ {
+ "$ref": "#/675"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VPN"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/677"
+ },
+ {
+ "$ref": "#/678"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedCassandraManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The object id of the identity resource."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The tenant id of the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/684"
+ },
+ "flags": 0,
+ "description": "The type of the resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/682"
+ },
+ {
+ "$ref": "#/683"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/cassandraClusters@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/640"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/cassandraClusters/dataCenters"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/637"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/686"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/687"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/689"
+ },
+ "flags": 0,
+ "description": "Properties of a managed Cassandra data center."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataCenterResourceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/696"
+ },
+ "flags": 0,
+ "description": "The status of the resource at the time the operation was called."
+ },
+ "dataCenterLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The region this data center should be created in."
+ },
+ "delegatedSubnetId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'."
+ },
+ "nodeCount": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster."
+ },
+ "seedNodes": {
+ "type": {
+ "$ref": "#/697"
+ },
+ "flags": 2,
+ "description": "IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster."
+ },
+ "base64EncodedCassandraYamlFragment": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed."
+ },
+ "managedDiskCustomerKeyUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key."
+ },
+ "backupStorageCustomerKeyUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Indicates the Key Uri of the customer key to use for encryption of the backup storage account."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2"
+ },
+ "diskSku": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Disk SKU used for data centers. Default value is P30."
+ },
+ "diskCapacity": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Number of disks attached to each node. Default is 4."
+ },
+ "availabilityZone": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines."
+ },
+ "authenticationMethodLdapProperties": {
+ "type": {
+ "$ref": "#/698"
+ },
+ "flags": 0,
+ "description": "Ldap authentication method properties. This feature is in preview."
+ },
+ "deallocated": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Whether the data center has been deallocated."
+ },
+ "provisionError": {
+ "type": {
+ "$ref": "#/669"
+ },
+ "flags": 0,
+ "description": "Error related to resource provisioning."
+ },
+ "privateEndpointIpAddress": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Ip of the VPN Endpoint for this data center."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/690"
+ },
+ {
+ "$ref": "#/691"
+ },
+ {
+ "$ref": "#/692"
+ },
+ {
+ "$ref": "#/693"
+ },
+ {
+ "$ref": "#/694"
+ },
+ {
+ "$ref": "#/695"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/654"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AuthenticationMethodLdapProperties",
+ "properties": {
+ "serverHostname": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Hostname of the LDAP server."
+ },
+ "serverPort": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Port of the LDAP server."
+ },
+ "serviceUserDistinguishedName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Distinguished name of the look up user account, who can look up user details on authentication."
+ },
+ "serviceUserPassword": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Password of the look up user."
+ },
+ "searchBaseDistinguishedName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Distinguished name of the object to start the recursive search of users from."
+ },
+ "searchFilterTemplate": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login."
+ },
+ "serverCertificates": {
+ "type": {
+ "$ref": "#/699"
+ },
+ "flags": 0
+ },
+ "connectionTimeoutInMs": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/659"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/cassandraClusters/dataCenters@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/688"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/701"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/702"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/703"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/704"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/706"
+ },
+ "flags": 2,
+ "description": "Resource properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NotebookWorkspaceProperties",
+ "properties": {
+ "notebookServerEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the endpoint of Notebook server."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/705"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/708"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/709"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "Resource properties."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/710"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 50
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/services"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/services",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/712"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/713"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/714"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/716"
+ },
+ "flags": 0,
+ "description": "Properties in ServiceResourceCreateUpdateParameters."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "ServiceResourceCreateUpdatePropertiesOrServiceResourceProperties",
+ "discriminator": "serviceType",
+ "baseProperties": {
+ "instanceSize": {
+ "type": {
+ "$ref": "#/720"
+ },
+ "flags": 0,
+ "description": "Instance type for the service."
+ },
+ "instanceCount": {
+ "type": {
+ "$ref": "#/68"
+ },
+ "flags": 0,
+ "description": "Instance count for the service."
+ },
+ "creationTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Time of the last state change (ISO-8601 format)."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/727"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ },
+ "elements": {
+ "DataTransfer": {
+ "$ref": "#/728"
+ },
+ "GraphAPICompute": {
+ "$ref": "#/739"
+ },
+ "MaterializedViewsBuilder": {
+ "$ref": "#/750"
+ },
+ "SqlDedicatedGateway": {
+ "$ref": "#/761"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cosmos.D4s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cosmos.D8s"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cosmos.D16s"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/717"
+ },
+ {
+ "$ref": "#/718"
+ },
+ {
+ "$ref": "#/719"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/721"
+ },
+ {
+ "$ref": "#/722"
+ },
+ {
+ "$ref": "#/723"
+ },
+ {
+ "$ref": "#/724"
+ },
+ {
+ "$ref": "#/725"
+ },
+ {
+ "$ref": "#/726"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataTransferServiceResourceCreateUpdatePropertiesOrDataTransferServiceResourceProperties",
+ "properties": {
+ "locations": {
+ "type": {
+ "$ref": "#/737"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/738"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataTransferRegionalServiceResource",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/736"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/730"
+ },
+ {
+ "$ref": "#/731"
+ },
+ {
+ "$ref": "#/732"
+ },
+ {
+ "$ref": "#/733"
+ },
+ {
+ "$ref": "#/734"
+ },
+ {
+ "$ref": "#/735"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/729"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DataTransfer"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GraphAPIComputeServiceResourceCreateUpdatePropertiesOrGraphAPIComputeServiceResourceProperties",
+ "properties": {
+ "graphApiComputeEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "GraphAPICompute endpoint for the service."
+ },
+ "locations": {
+ "type": {
+ "$ref": "#/748"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/749"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GraphAPIComputeRegionalServiceResource",
+ "properties": {
+ "graphApiComputeEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The regional endpoint for GraphAPICompute."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/747"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/741"
+ },
+ {
+ "$ref": "#/742"
+ },
+ {
+ "$ref": "#/743"
+ },
+ {
+ "$ref": "#/744"
+ },
+ {
+ "$ref": "#/745"
+ },
+ {
+ "$ref": "#/746"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/740"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GraphAPICompute"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaterializedViewsBuilderServiceResourceCreateUpdatePropertiesOrMaterializedViewsBuilderServiceResourceProperties",
+ "properties": {
+ "locations": {
+ "type": {
+ "$ref": "#/759"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/760"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MaterializedViewsBuilderRegionalServiceResource",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/758"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/752"
+ },
+ {
+ "$ref": "#/753"
+ },
+ {
+ "$ref": "#/754"
+ },
+ {
+ "$ref": "#/755"
+ },
+ {
+ "$ref": "#/756"
+ },
+ {
+ "$ref": "#/757"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/751"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MaterializedViewsBuilder"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDedicatedGatewayServiceResourceCreateUpdatePropertiesOrSqlDedicatedGatewayServiceResourceProperties",
+ "properties": {
+ "dedicatedGatewayType": {
+ "type": {
+ "$ref": "#/764"
+ },
+ "flags": 0,
+ "description": "DedicatedGatewayType for the service."
+ },
+ "sqlDedicatedGatewayEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "SqlDedicatedGateway endpoint for the service."
+ },
+ "locations": {
+ "type": {
+ "$ref": "#/773"
+ },
+ "flags": 2,
+ "description": "An array that contains all of the locations for the service."
+ },
+ "serviceType": {
+ "type": {
+ "$ref": "#/774"
+ },
+ "flags": 1,
+ "description": "ServiceType for the service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IntegratedCache"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DistributedQuery"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/762"
+ },
+ {
+ "$ref": "#/763"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlDedicatedGatewayRegionalServiceResource",
+ "properties": {
+ "sqlDedicatedGatewayEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The regional endpoint for SqlDedicatedGateway."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The regional service name."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The location name."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/772"
+ },
+ "flags": 2,
+ "description": "Describes the status of a service."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/766"
+ },
+ {
+ "$ref": "#/767"
+ },
+ {
+ "$ref": "#/768"
+ },
+ {
+ "$ref": "#/769"
+ },
+ {
+ "$ref": "#/770"
+ },
+ {
+ "$ref": "#/771"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/765"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlDedicatedGateway"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/services@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/715"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/throughputPools"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/throughputPools",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/776"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/777"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/779"
+ },
+ "flags": 0,
+ "description": "Properties to update Azure Cosmos DB throughput pool."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/791"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputPoolProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/790"
+ },
+ "flags": 0,
+ "description": "A provisioning state of the ThroughputPool."
+ },
+ "maxThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Value for throughput to be shared among CosmosDB resources in the pool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/780"
+ },
+ {
+ "$ref": "#/781"
+ },
+ {
+ "$ref": "#/782"
+ },
+ {
+ "$ref": "#/783"
+ },
+ {
+ "$ref": "#/784"
+ },
+ {
+ "$ref": "#/785"
+ },
+ {
+ "$ref": "#/786"
+ },
+ {
+ "$ref": "#/787"
+ },
+ {
+ "$ref": "#/788"
+ },
+ {
+ "$ref": "#/789"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/throughputPools@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/778"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/793"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/794"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/796"
+ },
+ "flags": 0,
+ "description": "An Azure Cosmos DB Global Database Account which is part of a Throughputpool."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputPoolAccountProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/807"
+ },
+ "flags": 0,
+ "description": "A provisioning state of the ThroughputPool Account."
+ },
+ "accountResourceIdentifier": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The resource identifier of global database account in the throughputPool."
+ },
+ "accountLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of global database account in the throughputPool."
+ },
+ "accountInstanceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The instance id of global database account in the throughputPool."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/797"
+ },
+ {
+ "$ref": "#/798"
+ },
+ {
+ "$ref": "#/799"
+ },
+ {
+ "$ref": "#/800"
+ },
+ {
+ "$ref": "#/801"
+ },
+ {
+ "$ref": "#/802"
+ },
+ {
+ "$ref": "#/803"
+ },
+ {
+ "$ref": "#/804"
+ },
+ {
+ "$ref": "#/805"
+ },
+ {
+ "$ref": "#/806"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/795"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleDefinitions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleDefinitions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/809"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/810"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/812"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB MongoMI Role Definition."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoMIRoleDefinitionResourceProperties",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The path id for the Role Definition."
+ },
+ "roleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "A user-friendly name for the Role Definition. Must be unique for the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/815"
+ },
+ "flags": 0,
+ "description": "Indicates whether the Role Definition was built-in or user created."
+ },
+ "assignableScopes": {
+ "type": {
+ "$ref": "#/816"
+ },
+ "flags": 0,
+ "description": "A set of fully qualified Scopes at or below which MongoMI Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist."
+ },
+ "permissions": {
+ "type": {
+ "$ref": "#/820"
+ },
+ "flags": 0,
+ "description": "The set of operations allowed through this Role Definition."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BuiltInRole"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomRole"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/813"
+ },
+ {
+ "$ref": "#/814"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PermissionAutoGenerated3",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The id for the permission."
+ },
+ "dataActions": {
+ "type": {
+ "$ref": "#/818"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are allowed."
+ },
+ "notDataActions": {
+ "type": {
+ "$ref": "#/819"
+ },
+ "flags": 0,
+ "description": "An array of data actions that are denied."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/817"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleDefinitions@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/811"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/822"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/823"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/825"
+ },
+ "flags": 0,
+ "description": "Properties to create and update an Azure Cosmos DB MongoMI Role Assignment."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoMIRoleAssignmentResourceProperties",
+ "properties": {
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated Role Definition."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The data plane resource path for which access is being granted through this MongoMI Role Assignment."
+ },
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this MongoMI Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/824"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/fleets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/fleets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/827"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/828"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/830"
+ },
+ "flags": 0,
+ "description": "Properties to update Azure Cosmos DB fleet resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/842"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetResourceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/841"
+ },
+ "flags": 0,
+ "description": "A provisioning state of the Fleet."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/831"
+ },
+ {
+ "$ref": "#/832"
+ },
+ {
+ "$ref": "#/833"
+ },
+ {
+ "$ref": "#/834"
+ },
+ {
+ "$ref": "#/835"
+ },
+ {
+ "$ref": "#/836"
+ },
+ {
+ "$ref": "#/837"
+ },
+ {
+ "$ref": "#/838"
+ },
+ {
+ "$ref": "#/839"
+ },
+ {
+ "$ref": "#/840"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/fleets@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/829"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/fleets/fleetAnalytics"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/fleets/fleetAnalytics",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/844"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/845"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/847"
+ },
+ "flags": 0
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetAnalyticsProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/858"
+ },
+ "flags": 0,
+ "description": "A provisioning state of the FleetAnalytics."
+ },
+ "storageLocationType": {
+ "type": {
+ "$ref": "#/861"
+ },
+ "flags": 0,
+ "description": "The type of the fleet analytics resource."
+ },
+ "storageLocationUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique identifier of the fleet analytics resource."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/848"
+ },
+ {
+ "$ref": "#/849"
+ },
+ {
+ "$ref": "#/850"
+ },
+ {
+ "$ref": "#/851"
+ },
+ {
+ "$ref": "#/852"
+ },
+ {
+ "$ref": "#/853"
+ },
+ {
+ "$ref": "#/854"
+ },
+ {
+ "$ref": "#/855"
+ },
+ {
+ "$ref": "#/856"
+ },
+ {
+ "$ref": "#/857"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StorageAccount"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FabricLakehouse"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/859"
+ },
+ {
+ "$ref": "#/860"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/fleets/fleetAnalytics@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/846"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/fleets/fleetspaces"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/fleets/fleetspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/863"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/864"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/866"
+ },
+ "flags": 0,
+ "description": "Properties to update Azure Cosmos DB Fleetspace."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetspaceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/877"
+ },
+ "flags": 0,
+ "description": "A provisioning state of the Fleetspace."
+ },
+ "fleetspaceApiKind": {
+ "type": {
+ "$ref": "#/879"
+ },
+ "flags": 0,
+ "description": "The kind of API this fleetspace belongs to. Acceptable values: 'NoSQL'"
+ },
+ "throughputPoolConfiguration": {
+ "type": {
+ "$ref": "#/880"
+ },
+ "flags": 0,
+ "description": "Configuration for throughput pool in the fleetspace."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/867"
+ },
+ {
+ "$ref": "#/868"
+ },
+ {
+ "$ref": "#/869"
+ },
+ {
+ "$ref": "#/870"
+ },
+ {
+ "$ref": "#/871"
+ },
+ {
+ "$ref": "#/872"
+ },
+ {
+ "$ref": "#/873"
+ },
+ {
+ "$ref": "#/874"
+ },
+ {
+ "$ref": "#/875"
+ },
+ {
+ "$ref": "#/876"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoSQL"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/878"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetspacePropertiesThroughputPoolConfiguration",
+ "properties": {
+ "minThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Minimum throughput for the pool."
+ },
+ "maxThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Maximum throughput for the pool."
+ },
+ "serviceTier": {
+ "type": {
+ "$ref": "#/883"
+ },
+ "flags": 0,
+ "description": "Service Tier for the fleetspace. GeneralPurpose types refers to single write region accounts that can be added to this fleetspace, whereas BusinessCritical refers to multi write region."
+ },
+ "dataRegions": {
+ "type": {
+ "$ref": "#/884"
+ },
+ "flags": 0,
+ "description": "List of data regions assigned to the fleetspace. Eg [westus2]"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GeneralPurpose"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BusinessCritical"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/881"
+ },
+ {
+ "$ref": "#/882"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/fleets/fleetspaces@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/865"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/fleets/fleetspaces/fleetspaceAccounts"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/fleets/fleetspaces/fleetspaceAccounts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/74"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/886"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/887"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/889"
+ },
+ "flags": 0,
+ "description": "An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FleetspaceAccountProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/900"
+ },
+ "flags": 0,
+ "description": "A provisioning state of the Fleetspace Account."
+ },
+ "accountResourceIdentifier": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The resource identifier of global database account in the Fleetspace Account."
+ },
+ "accountLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of global database account in the Fleetspace Account."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/890"
+ },
+ {
+ "$ref": "#/891"
+ },
+ {
+ "$ref": "#/892"
+ },
+ {
+ "$ref": "#/893"
+ },
+ {
+ "$ref": "#/894"
+ },
+ {
+ "$ref": "#/895"
+ },
+ {
+ "$ref": "#/896"
+ },
+ {
+ "$ref": "#/897"
+ },
+ {
+ "$ref": "#/898"
+ },
+ {
+ "$ref": "#/899"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/fleets/fleetspaces/fleetspaceAccounts@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/888"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/locations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/locations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/902"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/903"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/905"
+ },
+ "flags": 2,
+ "description": "Cosmos DB location metadata"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LocationProperties",
+ "properties": {
+ "supportsAvailabilityZone": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the location supports availability zones or not."
+ },
+ "isResidencyRestricted": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the location is residency sensitive."
+ },
+ "backupStorageRedundancies": {
+ "type": {
+ "$ref": "#/910"
+ },
+ "flags": 2,
+ "description": "The properties of available backup storage redundancies."
+ },
+ "isSubscriptionRegionAccessAllowedForRegular": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the subscription have access in region for Non-Availability Zones."
+ },
+ "isSubscriptionRegionAccessAllowedForAz": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Flag indicating whether the subscription have access in region for Availability Zones(Az)."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/921"
+ },
+ "flags": 2,
+ "description": "Enum to indicate current buildout status of the region."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Geo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Local"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Zone"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/906"
+ },
+ {
+ "$ref": "#/907"
+ },
+ {
+ "$ref": "#/908"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/909"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uninitialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InternallyReady"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/911"
+ },
+ {
+ "$ref": "#/912"
+ },
+ {
+ "$ref": "#/913"
+ },
+ {
+ "$ref": "#/914"
+ },
+ {
+ "$ref": "#/915"
+ },
+ {
+ "$ref": "#/916"
+ },
+ {
+ "$ref": "#/917"
+ },
+ {
+ "$ref": "#/918"
+ },
+ {
+ "$ref": "#/919"
+ },
+ {
+ "$ref": "#/920"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/locations@2025-05-01-preview",
+ "scopeType": 4,
+ "body": {
+ "$ref": "#/904"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^.*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/923"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/924"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/925"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/927"
+ },
+ "flags": 2,
+ "description": "Network security configuration properties."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkSecurityPerimeterConfigurationProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/935"
+ },
+ "flags": 2,
+ "description": "Provisioning state of a network security perimeter configuration that is being created or updated."
+ },
+ "provisioningIssues": {
+ "type": {
+ "$ref": "#/962"
+ },
+ "flags": 2,
+ "description": "List of provisioning issues, if any"
+ },
+ "networkSecurityPerimeter": {
+ "type": {
+ "$ref": "#/955"
+ },
+ "flags": 0,
+ "description": "Information about a network security perimeter (NSP)"
+ },
+ "resourceAssociation": {
+ "type": {
+ "$ref": "#/963"
+ },
+ "flags": 0,
+ "description": "Information about resource association"
+ },
+ "profile": {
+ "type": {
+ "$ref": "#/968"
+ },
+ "flags": 0,
+ "description": "Network security perimeter configuration profile"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/928"
+ },
+ {
+ "$ref": "#/929"
+ },
+ {
+ "$ref": "#/930"
+ },
+ {
+ "$ref": "#/931"
+ },
+ {
+ "$ref": "#/932"
+ },
+ {
+ "$ref": "#/933"
+ },
+ {
+ "$ref": "#/934"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProvisioningIssue",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Name of the issue"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/937"
+ },
+ "flags": 2,
+ "description": "Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProvisioningIssueProperties",
+ "properties": {
+ "issueType": {
+ "type": {
+ "$ref": "#/942"
+ },
+ "flags": 2,
+ "description": "Type of issue"
+ },
+ "severity": {
+ "type": {
+ "$ref": "#/945"
+ },
+ "flags": 2,
+ "description": "Severity of the issue."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Description of the issue"
+ },
+ "suggestedResourceIds": {
+ "type": {
+ "$ref": "#/946"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue."
+ },
+ "suggestedAccessRules": {
+ "type": {
+ "$ref": "#/961"
+ },
+ "flags": 2,
+ "description": "Access rules that can be added to the network security profile (NSP) to remediate the issue."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfigurationPropagationFailure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MissingPerimeterConfiguration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MissingIdentityConfiguration"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/938"
+ },
+ {
+ "$ref": "#/939"
+ },
+ {
+ "$ref": "#/940"
+ },
+ {
+ "$ref": "#/941"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/943"
+ },
+ {
+ "$ref": "#/944"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessRule",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the access rule"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/948"
+ },
+ "flags": 0,
+ "description": "Properties of Access Rule"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessRuleProperties",
+ "properties": {
+ "direction": {
+ "type": {
+ "$ref": "#/951"
+ },
+ "flags": 0,
+ "description": "Direction of Access Rule"
+ },
+ "addressPrefixes": {
+ "type": {
+ "$ref": "#/952"
+ },
+ "flags": 0,
+ "description": "Address prefixes in the CIDR format for inbound rules"
+ },
+ "subscriptions": {
+ "type": {
+ "$ref": "#/954"
+ },
+ "flags": 0,
+ "description": "Subscriptions for inbound rules"
+ },
+ "networkSecurityPerimeters": {
+ "type": {
+ "$ref": "#/957"
+ },
+ "flags": 0,
+ "description": "Network security perimeters for inbound rules"
+ },
+ "fullyQualifiedDomainNames": {
+ "type": {
+ "$ref": "#/958"
+ },
+ "flags": 0,
+ "description": "Fully qualified domain names (FQDN) for outbound rules"
+ },
+ "emailAddresses": {
+ "type": {
+ "$ref": "#/959"
+ },
+ "flags": 0,
+ "description": "Email addresses for outbound rules"
+ },
+ "phoneNumbers": {
+ "type": {
+ "$ref": "#/960"
+ },
+ "flags": 0,
+ "description": "Phone numbers for outbound rules"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Inbound"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Outbound"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/949"
+ },
+ {
+ "$ref": "#/950"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessRulePropertiesSubscriptionsItem",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000')"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/953"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkSecurityPerimeter",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Fully qualified Azure resource ID of the NSP resource"
+ },
+ "perimeterGuid": {
+ "type": {
+ "$ref": "#/956"
+ },
+ "flags": 0,
+ "description": "Universal unique ID (UUID) of the network security perimeter"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Location of the network security perimeter"
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/955"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/947"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/936"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceAssociation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the resource association"
+ },
+ "accessMode": {
+ "type": {
+ "$ref": "#/967"
+ },
+ "flags": 0,
+ "description": "Access mode of the resource association"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enforced"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Learning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Audit"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/964"
+ },
+ {
+ "$ref": "#/965"
+ },
+ {
+ "$ref": "#/966"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkSecurityProfile",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the profile"
+ },
+ "accessRulesVersion": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Current access rules version"
+ },
+ "accessRules": {
+ "type": {
+ "$ref": "#/969"
+ },
+ "flags": 0,
+ "description": "List of Access Rules"
+ },
+ "diagnosticSettingsVersion": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Current diagnostic settings version"
+ },
+ "enabledLogCategories": {
+ "type": {
+ "$ref": "#/970"
+ },
+ "flags": 0,
+ "description": "List of log categories that are enabled"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/947"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/926"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/972"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/973"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/975"
+ },
+ "flags": 2,
+ "description": "Resource properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkResourceProperties",
+ "properties": {
+ "groupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The private link resource group id."
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/976"
+ },
+ "flags": 2,
+ "description": "The private link resource required member names."
+ },
+ "requiredZoneNames": {
+ "type": {
+ "$ref": "#/977"
+ },
+ "flags": 2,
+ "description": "The private link resource required zone names."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources@2025-05-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/974"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CopyJobGetResults",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 1,
+ "description": "The properties of a Copy Job"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the database account."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "pause",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/copyJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/979"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resume",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/copyJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/979"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancel",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/copyJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/979"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "complete",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/copyJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/979"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FailoverPolicies",
+ "properties": {
+ "failoverPolicies": {
+ "type": {
+ "$ref": "#/985"
+ },
+ "flags": 1,
+ "description": "List of failover policies."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/185"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "failoverPriorityChange",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "input": {
+ "$ref": "#/984"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountListKeysResult",
+ "properties": {
+ "primaryMasterKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the primary read-write key."
+ },
+ "secondaryMasterKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the secondary read-write key."
+ },
+ "primaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the primary read-only key."
+ },
+ "secondaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the secondary read-only key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listKeys",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/987"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountListConnectionStringsResult",
+ "properties": {
+ "connectionStrings": {
+ "type": {
+ "$ref": "#/1006"
+ },
+ "flags": 0,
+ "description": "An array that contains the connection strings for the Cosmos DB account."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountConnectionString",
+ "properties": {
+ "connectionString": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Value of the connection string"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Description of the connection string"
+ },
+ "keyKind": {
+ "type": {
+ "$ref": "#/995"
+ },
+ "flags": 2,
+ "description": "Kind of the connection string key"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1005"
+ },
+ "flags": 2,
+ "description": "Type of the connection string"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Primary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Secondary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PrimaryReadonly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecondaryReadonly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/991"
+ },
+ {
+ "$ref": "#/992"
+ },
+ {
+ "$ref": "#/993"
+ },
+ {
+ "$ref": "#/994"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sql"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Table"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cassandra"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CassandraConnectorMetadata"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Gremlin"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlDedicatedGateway"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GremlinV2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Undefined"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/996"
+ },
+ {
+ "$ref": "#/997"
+ },
+ {
+ "$ref": "#/998"
+ },
+ {
+ "$ref": "#/999"
+ },
+ {
+ "$ref": "#/1000"
+ },
+ {
+ "$ref": "#/1001"
+ },
+ {
+ "$ref": "#/1002"
+ },
+ {
+ "$ref": "#/1003"
+ },
+ {
+ "$ref": "#/1004"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/990"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listConnectionStrings",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/989"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegionForOnlineOffline",
+ "properties": {
+ "region": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Cosmos DB region, with spaces between words and each word capitalized."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "offlineRegion",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "input": {
+ "$ref": "#/1008"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "onlineRegion",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "input": {
+ "$ref": "#/1008"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountListReadOnlyKeysResult",
+ "properties": {
+ "primaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the primary read-only key."
+ },
+ "secondaryReadonlyMasterKey": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Base 64 encoded value of the secondary read-only key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "readonlykeys",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1011"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseAccountRegenerateKeyParameters",
+ "properties": {
+ "keyKind": {
+ "type": {
+ "$ref": "#/1018"
+ },
+ "flags": 1,
+ "description": "The access key to regenerate."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "primary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "secondary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "primaryReadonly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "secondaryReadonly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1014"
+ },
+ {
+ "$ref": "#/1015"
+ },
+ {
+ "$ref": "#/1016"
+ },
+ {
+ "$ref": "#/1017"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateKey",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts",
+ "apiVersion": "2025-05-01-preview",
+ "input": {
+ "$ref": "#/1013"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsGetResults",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/1021"
+ },
+ "flags": 0,
+ "description": "The properties of an Azure Cosmos DB resource throughput"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the ARM resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the ARM resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/1024"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsGetProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/1022"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ThroughputSettingsGetPropertiesResource",
+ "properties": {
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "autoscaleSettings": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 0,
+ "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both."
+ },
+ "minimumThroughput": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The minimum throughput of the resource"
+ },
+ "offerReplacePending": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The throughput replace is pending"
+ },
+ "instantMaximumThroughput": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The offer throughput value to instantly scale up without triggering splits"
+ },
+ "softAllowedMaximumThroughput": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified"
+ },
+ "throughputBuckets": {
+ "type": {
+ "$ref": "#/1023"
+ },
+ "flags": 0,
+ "description": "Array of Throughput Bucket limits to be applied to the Cosmos DB container"
+ },
+ "_rid": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property. A unique identifier."
+ },
+ "_ts": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "A system generated property that denotes the last updated timestamp of the resource."
+ },
+ "_etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A system generated property representing the resource etag required for optimistic concurrency control."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/247"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetrieveThroughputParameters",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/1028"
+ },
+ "flags": 1,
+ "description": "Properties to retrieve throughput parameters object"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the ARM resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the ARM resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/1032"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetrieveThroughputProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/1029"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a resource throughput"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetrieveThroughputPropertiesResource",
+ "properties": {
+ "physicalPartitionIds": {
+ "type": {
+ "$ref": "#/1031"
+ },
+ "flags": 1,
+ "description": "Array of PhysicalPartitionId objects."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionId",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Id of a physical partition"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1030"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionThroughputInfoResult",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/1034"
+ },
+ "flags": 0,
+ "description": "The properties of an Azure Cosmos DB PhysicalPartitionThroughputInfoResult object"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the ARM resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the ARM resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/1038"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionThroughputInfoResultProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/1035"
+ },
+ "flags": 0,
+ "description": "properties of physical partition throughput info"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionThroughputInfoResultPropertiesResource",
+ "properties": {
+ "physicalPartitionThroughputInfo": {
+ "type": {
+ "$ref": "#/1037"
+ },
+ "flags": 0,
+ "description": "Array of physical partition throughput info objects"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionThroughputInfoResource",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Id of a physical partition"
+ },
+ "throughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Throughput of a physical partition"
+ },
+ "targetThroughput": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Target throughput of a physical partition"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1036"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveThroughputDistribution",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1027"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RedistributeThroughputParameters",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/1041"
+ },
+ "flags": 1,
+ "description": "Properties to redistribute throughput parameters object"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the ARM resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the ARM resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The location of the resource group to which the resource belongs."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/1049"
+ },
+ "flags": 0,
+ "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Identity for the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RedistributeThroughputProperties",
+ "properties": {
+ "resource": {
+ "type": {
+ "$ref": "#/1042"
+ },
+ "flags": 1,
+ "description": "The standard JSON format of a resource throughput"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RedistributeThroughputPropertiesResource",
+ "properties": {
+ "throughputPolicy": {
+ "type": {
+ "$ref": "#/1046"
+ },
+ "flags": 1,
+ "description": "ThroughputPolicy to apply for throughput redistribution"
+ },
+ "targetPhysicalPartitionThroughputInfo": {
+ "type": {
+ "$ref": "#/1047"
+ },
+ "flags": 1,
+ "description": "Array of PhysicalPartitionThroughputInfoResource objects."
+ },
+ "sourcePhysicalPartitionThroughputInfo": {
+ "type": {
+ "$ref": "#/1048"
+ },
+ "flags": 1,
+ "description": "Array of PhysicalPartitionThroughputInfoResource objects."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "equal"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1043"
+ },
+ {
+ "$ref": "#/1044"
+ },
+ {
+ "$ref": "#/1045"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1036"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1036"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Tags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redistributeThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1040"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MergeParameters",
+ "properties": {
+ "isDryRun": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Specifies whether the operation is a real merge operation or a simulation."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionStorageInfoCollection",
+ "properties": {
+ "physicalPartitionStorageInfoCollection": {
+ "type": {
+ "$ref": "#/1054"
+ },
+ "flags": 2,
+ "description": "List of physical partitions and their properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PhysicalPartitionStorageInfo",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique identifier of the partition."
+ },
+ "storageInKB": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 2,
+ "description": "The storage in KB for the physical partition."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1053"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "partitionMerge",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1052"
+ },
+ "input": {
+ "$ref": "#/1051"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "partitionMerge",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1052"
+ },
+ "input": {
+ "$ref": "#/1051"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousBackupRestoreLocation",
+ "properties": {
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the continuous backup restore location."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupInformation",
+ "properties": {
+ "continuousBackupInformation": {
+ "type": {
+ "$ref": "#/1059"
+ },
+ "flags": 2,
+ "description": "Information about the status of continuous backups."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ContinuousBackupInformation",
+ "properties": {
+ "latestRestorableTimestamp": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The latest restorable timestamp for a resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1058"
+ },
+ "input": {
+ "$ref": "#/1057"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveThroughputDistribution",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1027"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redistributeThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1040"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveThroughputDistribution",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1027"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redistributeThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1040"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveThroughputDistribution",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1027"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "redistributeThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1033"
+ },
+ "input": {
+ "$ref": "#/1040"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "partitionMerge",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1052"
+ },
+ "input": {
+ "$ref": "#/1051"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "partitionMerge",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1052"
+ },
+ "input": {
+ "$ref": "#/1051"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1058"
+ },
+ "input": {
+ "$ref": "#/1057"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/tables",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1058"
+ },
+ "input": {
+ "$ref": "#/1057"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToAutoscale",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "migrateToManualThroughput",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1020"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retrieveContinuousBackupInformation",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1058"
+ },
+ "input": {
+ "$ref": "#/1057"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataTransferJobGetResults",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/621"
+ },
+ "flags": 0,
+ "description": "The properties of a DataTransfer Job"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The unique resource identifier of the database account."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The name of the database account."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The type of Azure resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "pause",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1090"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resume",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1090"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancel",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1090"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "complete",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1090"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandPostBody",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The command which should be run"
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/1096"
+ },
+ "flags": 0,
+ "description": "The arguments for the command to be run"
+ },
+ "host": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "IP address of the cassandra host to run the command on"
+ },
+ "cassandra-stop-start": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If true, stops cassandra before executing the command and then start it again"
+ },
+ "readwrite": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandPostBodyArguments",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "invokeCommand",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-05-01-preview",
+ "input": {
+ "$ref": "#/1095"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandAsyncPostBody",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The command which should be run"
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 0,
+ "description": "The arguments for the command to be run"
+ },
+ "host": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "IP address of the cassandra host to run the command on"
+ },
+ "cassandra-stop-start": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If true, stops cassandra before executing the command and then start it again"
+ },
+ "readWrite": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommandPublicResource",
+ "properties": {
+ "command": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The command which should be run"
+ },
+ "commandId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The unique id of command"
+ },
+ "arguments": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 0,
+ "description": "The arguments for the command to be run"
+ },
+ "host": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "IP address of the cassandra host to run the command on"
+ },
+ "isAdmin": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Whether command has admin privileges"
+ },
+ "cassandraStopStart": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If true, stops cassandra before executing the command and then start it again"
+ },
+ "readWrite": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only."
+ },
+ "result": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Result output of the command."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/1106"
+ },
+ "flags": 0,
+ "description": "Status of the command."
+ },
+ "outputFile": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The name of the file where the result is written."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Done"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enqueue"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Processing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Finished"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1100"
+ },
+ {
+ "$ref": "#/1101"
+ },
+ {
+ "$ref": "#/1102"
+ },
+ {
+ "$ref": "#/1103"
+ },
+ {
+ "$ref": "#/1104"
+ },
+ {
+ "$ref": "#/1105"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "invokeCommandAsync",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1099"
+ },
+ "input": {
+ "$ref": "#/1098"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deallocate",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-05-01-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.DocumentDB/cassandraClusters",
+ "apiVersion": "2025-05-01-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "reconcile",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations",
+ "apiVersion": "2025-05-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NotebookWorkspaceConnectionInfoResult",
+ "properties": {
+ "authToken": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies auth token used for connecting to Notebook server (uses token-based auth)."
+ },
+ "notebookServerEndpoint": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the endpoint of Notebook server."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listConnectionInfo",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "apiVersion": "2025-05-01-preview",
+ "output": {
+ "$ref": "#/1111"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateAuthToken",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "apiVersion": "2025-05-01-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
+ "apiVersion": "2025-05-01-preview"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/cost-management/microsoft.costmanagement/2024-10-01-preview/types.json b/internal/azure/generated/cost-management/microsoft.costmanagement/2024-10-01-preview/types.json
new file mode 100644
index 000000000..168ccc5cc
--- /dev/null
+++ b/internal/azure/generated/cost-management/microsoft.costmanagement/2024-10-01-preview/types.json
@@ -0,0 +1,5776 @@
+[
+ {
+ "$type": "StringType",
+ "pattern": "[A-Za-z0-9\\-_]+"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/costAllocationRules"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/costAllocationRules",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Cost allocation rule properties"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostAllocationRuleProperties",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Description of a cost allocation rule."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 1,
+ "description": "Resource information for the cost allocation rule"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 1,
+ "description": "Status of the rule"
+ },
+ "createdDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation."
+ },
+ "updatedDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Time at which the rule was last updated."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostAllocationRuleDetails",
+ "properties": {
+ "sourceResources": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Source resources for cost allocation. At this time, this list can contain no more than one element."
+ },
+ "targetResources": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "Target resources for cost allocation. At this time, this list can contain no more than one element."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceCostAllocationResource",
+ "properties": {
+ "values": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 1,
+ "description": "Source Resources for cost allocation. This list cannot contain more than 25 values."
+ },
+ "resourceType": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 1,
+ "description": "Type of resources contained in this cost allocation rule"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tag"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/7"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TargetCostAllocationResource",
+ "properties": {
+ "values": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 1,
+ "description": "Target resources for cost allocation. This list cannot contain more than 25 values."
+ },
+ "policyType": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 1,
+ "description": "Method of cost allocation for the rule"
+ },
+ "resourceType": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 1,
+ "description": "Type of resources contained in this cost allocation rule"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostAllocationProportion",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Target resource for cost allocation"
+ },
+ "percentage": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 1,
+ "description": "Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/14"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FixedProportion"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tag"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/13"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotActive"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Processing"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/23"
+ },
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/costAllocationRules@2024-10-01-preview",
+ "scopeType": 16,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9_-]+$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/budgets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/budgets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The properties of the budget."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetProperties",
+ "properties": {
+ "category": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 1,
+ "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule."
+ },
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The total amount of cost to track with the budget.\n\n Supported for CategoryType(s): Cost.\n\n Required for CategoryType(s): Cost."
+ },
+ "timeGrain": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 1,
+ "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported timeGrainTypes for **CategoryType: Cost**\n\n- Monthly\n- Quarterly\n- Annually\n- BillingMonth*\n- BillingQuarter*\n- BillingAnnual*\n\n *only supported for Web Direct customers.\n\n Supported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\n Required for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 1,
+ "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "currentSpend": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 2,
+ "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost."
+ },
+ "notifications": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Dictionary of notifications associated with the budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n- Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.\n- Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable."
+ },
+ "forecastSpend": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 2,
+ "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationUtilization"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Quarterly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Annually"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingQuarter"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingAnnual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last7Days"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last30Days"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetTimePeriod",
+ "properties": {
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date for the budget.\n\n- Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.\n\n- Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date."
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end date for the budget.\n\n- Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date.\n\n- Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items.\n\n Supported for CategoryType(s): Cost."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetFilterProperties",
+ "properties": {
+ "dimensions": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/50"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/47"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CurrentSpend",
+ "properties": {
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 2,
+ "description": "The total amount of cost which is being tracked by the budget."
+ },
+ "unit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unit of measure for the budget amount."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Notification",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 1,
+ "description": "The notification is enabled or not.\n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "The comparison operator.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\n Supported operators for **CategoryType: ReservationUtilization**\n- LessThan"
+ },
+ "threshold": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 1,
+ "description": "Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n **CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold.\n\n **CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold."
+ },
+ "frequency": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 0,
+ "description": "Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).\n\n Supported for CategoryType(s): ReservationUtilization."
+ },
+ "contactEmails": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 1,
+ "description": "Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.\n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "contactRoles": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 0,
+ "description": "Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.\n\n Supported for CategoryType(s): Cost."
+ },
+ "contactGroups": {
+ "type": {
+ "$ref": "#/67"
+ },
+ "flags": 0,
+ "description": "Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id.\n\n Supported for CategoryType(s): Cost."
+ },
+ "thresholdType": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 0,
+ "description": "The type of threshold.\n\n Supported for CategoryType(s): Cost."
+ },
+ "locale": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "Language in which the recipient will receive the notification, \n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThan"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThanOrEqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LessThan"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/59"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Weekly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 50
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 50
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Actual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Forecasted"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "en-us"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ja-jp"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "zh-cn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "de-de"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "es-es"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "fr-fr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "it-it"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ko-kr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pt-br"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ru-ru"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "zh-tw"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cs-cz"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pl-pl"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "tr-tr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "da-dk"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "en-gb"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "hu-hu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "nb-no"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "nl-nl"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pt-pt"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "sv-se"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/74"
+ },
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/81"
+ },
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/88"
+ },
+ {
+ "$ref": "#/89"
+ },
+ {
+ "$ref": "#/90"
+ },
+ {
+ "$ref": "#/91"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetPropertiesNotifications",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/54"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastSpend",
+ "properties": {
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 2,
+ "description": "The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type."
+ },
+ "unit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unit of measure for the budget amount."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/budgets@2024-10-01-preview",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/31"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/exports"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/exports",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "The managed identity associated with Export"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the Export's managed identity. Only required when utilizing managed identity."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The properties of the export."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemAssignedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/103"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (either system assigned, or none)."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportProperties",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "Has schedule information for the export."
+ },
+ "format": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 0,
+ "description": "The format of the export being delivered."
+ },
+ "deliveryInfo": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 1,
+ "description": "Has delivery information for the export."
+ },
+ "definition": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 1,
+ "description": "Has the definition for the export."
+ },
+ "runHistory": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 0,
+ "description": "If requested, has the most recent run history for the export."
+ },
+ "partitionData": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes."
+ },
+ "dataOverwriteBehavior": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 0,
+ "description": "Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport."
+ },
+ "compressionMode": {
+ "type": {
+ "$ref": "#/193"
+ },
+ "flags": 0,
+ "description": "Allow customers to select compress data(gzip) for exports. This setting will enable destination file compression scheme at runtime. By default set to None."
+ },
+ "exportDescription": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The export description set by customer at time of export creation/update."
+ },
+ "nextRunTimeEstimate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If the export has an active schedule, provides an estimate of the next run time."
+ },
+ "systemSuspensionContext": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 2,
+ "description": "The export suspension reason if export is in SystemSuspended state."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportSchedule",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 0,
+ "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused. 'SystemSuspended' can only be set by export service."
+ },
+ "recurrence": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "The schedule recurrence."
+ },
+ "recurrencePeriod": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Inactive"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemSuspended"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/106"
+ },
+ {
+ "$ref": "#/107"
+ },
+ {
+ "$ref": "#/108"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Weekly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Annually"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/113"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRecurrencePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date of recurrence."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end date of recurrence."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Csv"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Parquet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delta"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/116"
+ },
+ {
+ "$ref": "#/117"
+ },
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDeliveryInfo",
+ "properties": {
+ "destination": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 1,
+ "description": "Has destination for the export being delivered."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDeliveryDestination",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "The export delivery destination type. Currently only 'AzureBlob' and 'MicrosoftFabric' is supported. If no value is provided it will default to 'AzureBlob'."
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified."
+ },
+ "container": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the container where exports will be uploaded. If the container does not exist it will be created."
+ },
+ "rootFolderPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the directory where exports will be uploaded."
+ },
+ "sasToken": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 0,
+ "description": "A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified."
+ },
+ "storageAccount": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId."
+ },
+ "microsoftFabricSettings": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "The settings for the Microsoft Fabric destination. This is only applicable when destination.type == 'MicrosoftFabric'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBlob"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MicrosoftFabric"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MicrosoftFabricDestinationSettings",
+ "properties": {
+ "workspace": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 0,
+ "description": "The Microsoft Fabric Workspace Identifier."
+ },
+ "lakehouse": {
+ "type": {
+ "$ref": "#/128"
+ },
+ "flags": 0,
+ "description": "The Microsoft Fabric Lakehouse Identifier."
+ },
+ "tableName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the Microsoft Fabric Lakehouse Delta table where export data will be ingested to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FabricWorkspace",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identifier of the fabric workspace."
+ },
+ "displayName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The display name of the fabric workspace. This is only returned in Get operations."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FabricLakehouse",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identifier of the fabric lakehouse."
+ },
+ "displayName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The display name of the fabric lakehouse. This is only returned in Get operations."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 1,
+ "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the export."
+ },
+ "dataSet": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "The definition for data in the export."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FocusCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PriceSheet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationTransactions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationRecommendations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationDetails"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/132"
+ },
+ {
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/134"
+ },
+ {
+ "$ref": "#/135"
+ },
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/137"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastBillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WeekToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheCurrentMonth"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/139"
+ },
+ {
+ "$ref": "#/140"
+ },
+ {
+ "$ref": "#/141"
+ },
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/144"
+ },
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date for export data."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date for export data."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the export. Currently 'Daily' is supported for most cases."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "The export dataset configuration."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 0,
+ "description": "This is on path to deprecation and will not be supported going forward."
+ },
+ "dataVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The data version for the selected for the export. If not provided then the export will default to latest data version."
+ },
+ "filters": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "Filters associated with the data sets."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FilterItems",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/158"
+ },
+ "flags": 0,
+ "description": "The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType']"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Value to filter by. Currently values supported per name are, for 'ReservationScope' supported values are ['Single', 'Shared'], for 'LookBackPeriod' supported values are ['Last7Days', 'Last30Days', 'Last60Days'] and for 'ResourceType' supported values are ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple']."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationScope"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ResourceType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LookBackPeriod"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ },
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/154"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportExecutionListResult",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 2,
+ "description": "A list of export runs."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRun",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "The properties of the export run."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Id."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRunProperties",
+ "properties": {
+ "executionType": {
+ "type": {
+ "$ref": "#/165"
+ },
+ "flags": 0,
+ "description": "The type of the export run."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 0,
+ "description": "The last known status of the export run."
+ },
+ "submittedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'."
+ },
+ "submittedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when export was queued to be run."
+ },
+ "processingStartTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when export was picked up to be run."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The start datetime for the export."
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end datetime for the export."
+ },
+ "processingEndTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when the export run finished."
+ },
+ "fileName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the exported file."
+ },
+ "manifestFile": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The manifest file location(URI location) for the exported files."
+ },
+ "runSettings": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 0,
+ "description": "The export settings that were in effect for this run."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 0,
+ "description": "The details of any error."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OnDemand"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Scheduled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/163"
+ },
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Queued"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Timeout"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NewDataNotAvailable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DataNotAvailable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/169"
+ },
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommonExportProperties",
+ "properties": {
+ "format": {
+ "type": {
+ "$ref": "#/178"
+ },
+ "flags": 0,
+ "description": "The format of the export being delivered."
+ },
+ "deliveryInfo": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 1,
+ "description": "Has delivery information for the export."
+ },
+ "definition": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 1,
+ "description": "Has the definition for the export."
+ },
+ "runHistory": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 0,
+ "description": "If requested, has the most recent run history for the export."
+ },
+ "partitionData": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes."
+ },
+ "dataOverwriteBehavior": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 0,
+ "description": "Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport."
+ },
+ "compressionMode": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Allow customers to select compress data(gzip) for exports. This setting will enable destination file compression scheme at runtime. By default set to None."
+ },
+ "exportDescription": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The export description set by customer at time of export creation/update."
+ },
+ "nextRunTimeEstimate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If the export has an active schedule, provides an estimate of the next run time."
+ },
+ "systemSuspensionContext": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 2,
+ "description": "The export suspension reason if export is in SystemSuspended state."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Csv"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Parquet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Delta"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/176"
+ },
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwritePreviousReport"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateNewReport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/179"
+ },
+ {
+ "$ref": "#/180"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "gzip"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportSuspensionContext",
+ "properties": {
+ "suspensionCode": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The code for export suspension."
+ },
+ "suspensionReason": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The detailed reason for export suspension."
+ },
+ "suspensionTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when the export was suspended."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ErrorDetails",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Error code."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Error message indicating why the operation failed."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/161"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwritePreviousReport"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateNewReport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/188"
+ },
+ {
+ "$ref": "#/189"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "gzip"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/191"
+ },
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/exports@2024-10-01-preview",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/98"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/views"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/views",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 0,
+ "description": "The properties of the view."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ViewProperties",
+ "properties": {
+ "displayName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User input name of the view. Required."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope."
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Date the user created this view."
+ },
+ "modifiedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date when the user last modified this view."
+ },
+ "dateRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date range of the current view."
+ },
+ "currency": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Currency of the current view."
+ },
+ "query": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "Query body configuration. Required."
+ },
+ "chart": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 0,
+ "description": "Chart type of the main view in Cost Analysis. Required."
+ },
+ "accumulated": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 0,
+ "description": "Show costs accumulated over time."
+ },
+ "metric": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "Metric to use when displaying costs."
+ },
+ "kpis": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "List of KPIs to show in Cost Analysis UI."
+ },
+ "pivots": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 0,
+ "description": "Configuration of 3 sub-views in the Cost Analysis UI."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the report."
+ },
+ "dataSet": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Has definition for data in this report config."
+ },
+ "includeMonetaryCommitment": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "If true, report includes monetary commitment."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/200"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WeekToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "YearToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/203"
+ },
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date to pull data from."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date to pull data to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the report."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided."
+ },
+ "aggregation": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses."
+ },
+ "grouping": {
+ "type": {
+ "$ref": "#/222"
+ },
+ "flags": 0,
+ "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses."
+ },
+ "sorting": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "Array of order by expression to use in the report."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "Has filter expression to use in the report."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/213"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigAggregation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to aggregate."
+ },
+ "function": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 1,
+ "description": "The name of the aggregation function to use."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sum"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/215"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDatasetAggregation",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/214"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigGrouping",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 1,
+ "description": "Has type of the column to group."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to group. This version supports subscription lowest possible grain."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TagKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/219"
+ },
+ {
+ "$ref": "#/220"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/218"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigSorting",
+ "properties": {
+ "direction": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "Direction of sort."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to sort."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ascending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Descending"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items."
+ },
+ "or": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 0,
+ "description": "The logical \"OR\" expression. Must have at least 2 items."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/228"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/228"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Contains"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/232"
+ },
+ {
+ "$ref": "#/233"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Area"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Line"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StackedColumn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GroupedColumn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Table"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/236"
+ },
+ {
+ "$ref": "#/237"
+ },
+ {
+ "$ref": "#/238"
+ },
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/240"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "true"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "false"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/243"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AHUB"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/245"
+ },
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KpiProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "KPI type (Forecast, Budget)."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "ID of resource related to metric (budget)."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "show the KPI in the UI?"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Forecast"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Budget"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/250"
+ },
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/249"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PivotProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/257"
+ },
+ "flags": 0,
+ "description": "Data type to show in view."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data field to show in view."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TagKey"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/254"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/views@2024-10-01-preview",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/197"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/scheduledActions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/scheduledActions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 0,
+ "description": "The properties of the scheduled action."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Etag. For update calls, eTag is optional and can be specified to achieve optimistic concurrency. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 0,
+ "description": "Kind of the scheduled action."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 2,
+ "description": "Kind of the scheduled action."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduledActionProperties",
+ "properties": {
+ "displayName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Scheduled action name."
+ },
+ "fileDestination": {
+ "type": {
+ "$ref": "#/264"
+ },
+ "flags": 0,
+ "description": "Destination format of the view data. This is optional."
+ },
+ "notification": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 1,
+ "description": "Notification properties based on scheduled action kind."
+ },
+ "notificationEmail": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails."
+ },
+ "schedule": {
+ "type": {
+ "$ref": "#/271"
+ },
+ "flags": 1,
+ "description": "Schedule of the scheduled action."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For private scheduled action(Create or Update), scope will be empty. For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/295"
+ },
+ "flags": 1,
+ "description": "Status of the scheduled action."
+ },
+ "viewId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileDestination",
+ "properties": {
+ "fileFormats": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 0,
+ "description": "Destination of the view data. Currently only CSV format is supported."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Csv"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/266"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NotificationProperties",
+ "properties": {
+ "to": {
+ "type": {
+ "$ref": "#/270"
+ },
+ "flags": 1,
+ "description": "Array of email addresses."
+ },
+ "language": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Locale of the email."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Optional message to be added in the email. Length is limited to 250 characters."
+ },
+ "regionalFormat": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Regional format used for formatting date/time and currency values in the email."
+ },
+ "subject": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Subject of the email. Length is limited to 70 characters."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/269"
+ },
+ "minLength": 1,
+ "maxLength": 20
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduleProperties",
+ "properties": {
+ "frequency": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 1,
+ "description": "Frequency of the schedule."
+ },
+ "hourOfDay": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "UTC time at which cost analysis data will be emailed."
+ },
+ "daysOfWeek": {
+ "type": {
+ "$ref": "#/284"
+ },
+ "flags": 0,
+ "description": "Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly."
+ },
+ "weeksOfMonth": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 0,
+ "description": "Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek."
+ },
+ "dayOfMonth": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date and time of the scheduled action (UTC)."
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date and time of the scheduled action (UTC)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Weekly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/272"
+ },
+ {
+ "$ref": "#/273"
+ },
+ {
+ "$ref": "#/274"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/277"
+ },
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/281"
+ },
+ {
+ "$ref": "#/282"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/283"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/285"
+ },
+ {
+ "$ref": "#/286"
+ },
+ {
+ "$ref": "#/287"
+ },
+ {
+ "$ref": "#/288"
+ },
+ {
+ "$ref": "#/289"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/290"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Expired"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/292"
+ },
+ {
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Email"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InsightAlert"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/296"
+ },
+ {
+ "$ref": "#/297"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/300"
+ },
+ {
+ "$ref": "#/301"
+ },
+ {
+ "$ref": "#/302"
+ },
+ {
+ "$ref": "#/303"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/305"
+ },
+ {
+ "$ref": "#/306"
+ },
+ {
+ "$ref": "#/307"
+ },
+ {
+ "$ref": "#/308"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/scheduledActions@2024-10-01-preview",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/262"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "taginheritance"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/311"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/settings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "Microsoft.CostManagement/settings",
+ "discriminator": "kind",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/314"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ }
+ },
+ "elements": {
+ "taginheritance": {
+ "$ref": "#/316"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TagInheritanceSetting",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/317"
+ },
+ "flags": 0,
+ "description": "The properties of the tag inheritance setting."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 1,
+ "description": "Specifies the kind of settings."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TagInheritanceProperties",
+ "properties": {
+ "preferContainerTags": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 1,
+ "description": "This property defines the behavior when an inherited tag being applied matches a lower scope tag (Eg. Subscription tag matches the resource tag). If set to true - when tags match, the highest scope tags will be applied. Billing profile is the highest scope, followed by invoice sections, subscriptions and resource groups (allows overriding of lower scope tag values). If set to false - when tags match, the lowest scope tags will be applied. So, if a resource has the same tag as a subscription tag, the resource tag will be applied (does not allow overriding of lower scope tag values)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "taginheritance"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/settings@2024-10-01-preview",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/315"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/alerts"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-10-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/alerts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/320"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 2,
+ "description": "Alert properties."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AlertProperties",
+ "properties": {
+ "definition": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 0,
+ "description": "defines the type of alert"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Alert description"
+ },
+ "source": {
+ "type": {
+ "$ref": "#/355"
+ },
+ "flags": 0,
+ "description": "Source of alert"
+ },
+ "details": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 0,
+ "description": "Alert details"
+ },
+ "costEntityId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "related budget"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/384"
+ },
+ "flags": 0,
+ "description": "alert status"
+ },
+ "creationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which alert was created"
+ },
+ "closeTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which alert was closed"
+ },
+ "modificationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which alert was last modified"
+ },
+ "statusModificationUserName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User who last modified the alert"
+ },
+ "statusModificationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which the alert status was last modified"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AlertPropertiesDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 0,
+ "description": "type of alert"
+ },
+ "category": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 0,
+ "description": "Alert category"
+ },
+ "criteria": {
+ "type": {
+ "$ref": "#/352"
+ },
+ "flags": 0,
+ "description": "Criteria that triggered alert"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Budget"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invoice"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Credit"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Quota"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "General"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "xCloud"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BudgetForecast"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/325"
+ },
+ {
+ "$ref": "#/326"
+ },
+ {
+ "$ref": "#/327"
+ },
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/329"
+ },
+ {
+ "$ref": "#/330"
+ },
+ {
+ "$ref": "#/331"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Billing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/333"
+ },
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/335"
+ },
+ {
+ "$ref": "#/336"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CostThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UsageThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreditThresholdApproaching"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreditThresholdReached"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "QuotaThresholdApproaching"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "QuotaThresholdReached"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiCurrency"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForecastCostThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForecastUsageThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InvoiceDueDateApproaching"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InvoiceDueDateReached"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CrossCloudNewDataAvailable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CrossCloudCollectionError"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GeneralThresholdError"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/343"
+ },
+ {
+ "$ref": "#/344"
+ },
+ {
+ "$ref": "#/345"
+ },
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/347"
+ },
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ },
+ {
+ "$ref": "#/350"
+ },
+ {
+ "$ref": "#/351"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Preset"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/353"
+ },
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AlertPropertiesDetails",
+ "properties": {
+ "timeGrainType": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 0,
+ "description": "Type of timegrain cadence"
+ },
+ "periodStartDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "datetime of periodStartDate"
+ },
+ "triggeredBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "notificationId that triggered this alert"
+ },
+ "resourceGroupFilter": {
+ "type": {
+ "$ref": "#/366"
+ },
+ "flags": 0,
+ "description": "array of resourceGroups to filter by"
+ },
+ "resourceFilter": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 0,
+ "description": "array of resources to filter by"
+ },
+ "meterFilter": {
+ "type": {
+ "$ref": "#/368"
+ },
+ "flags": 0,
+ "description": "array of meters to filter by"
+ },
+ "tagFilter": {
+ "type": {
+ "$ref": "#/365"
+ },
+ "flags": 0,
+ "description": "tags to filter by"
+ },
+ "threshold": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "notification threshold percentage as a decimal which activated this alert"
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/375"
+ },
+ "flags": 0,
+ "description": "operator used to compare currentSpend with amount"
+ },
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "budget threshold amount"
+ },
+ "unit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "unit of currency being used"
+ },
+ "currentSpend": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "current spend"
+ },
+ "contactEmails": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 0,
+ "description": "list of emails to contact"
+ },
+ "contactGroups": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 0,
+ "description": "list of action groups to broadcast to"
+ },
+ "contactRoles": {
+ "type": {
+ "$ref": "#/378"
+ },
+ "flags": 0,
+ "description": "list of contact roles"
+ },
+ "overridingAlert": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "overriding alert"
+ },
+ "departmentName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "department name"
+ },
+ "companyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "company name"
+ },
+ "enrollmentNumber": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "enrollment number"
+ },
+ "enrollmentStartDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "datetime of enrollmentStartDate"
+ },
+ "enrollmentEndDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "datetime of enrollmentEndDate"
+ },
+ "invoicingThreshold": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "invoicing threshold"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Quarterly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Annually"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingQuarter"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/357"
+ },
+ {
+ "$ref": "#/358"
+ },
+ {
+ "$ref": "#/359"
+ },
+ {
+ "$ref": "#/360"
+ },
+ {
+ "$ref": "#/361"
+ },
+ {
+ "$ref": "#/362"
+ },
+ {
+ "$ref": "#/363"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/365"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/365"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/365"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThan"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThanOrEqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LessThan"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LessThanOrEqualTo"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/370"
+ },
+ {
+ "$ref": "#/371"
+ },
+ {
+ "$ref": "#/372"
+ },
+ {
+ "$ref": "#/373"
+ },
+ {
+ "$ref": "#/374"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Overridden"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Resolved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dismissed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/382"
+ },
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/alerts@2024-10-01-preview",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/322"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRunRequest",
+ "properties": {
+ "timePeriod": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the export."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "run",
+ "resourceType": "Microsoft.CostManagement/exports",
+ "apiVersion": "2024-10-01-preview",
+ "input": {
+ "$ref": "#/386"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/392"
+ },
+ "flags": 1,
+ "description": "The type of the forecast."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/394"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the forecast."
+ },
+ "dataset": {
+ "type": {
+ "$ref": "#/396"
+ },
+ "flags": 1,
+ "description": "Has definition for data in this forecast."
+ },
+ "includeActualCost": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "A boolean determining if actualCost will be included."
+ },
+ "includeFreshPartialCost": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "A boolean determining if FreshPartialCost will be included."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/389"
+ },
+ {
+ "$ref": "#/390"
+ },
+ {
+ "$ref": "#/391"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/393"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date to pull data from."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date to pull data to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/399"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the forecast."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/400"
+ },
+ "flags": 0,
+ "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided."
+ },
+ "aggregation": {
+ "type": {
+ "$ref": "#/410"
+ },
+ "flags": 1,
+ "description": "Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 0,
+ "description": "Has filter expression to use in the forecast."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/397"
+ },
+ {
+ "$ref": "#/398"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastAggregation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 1,
+ "description": "The name of the column to aggregate."
+ },
+ "function": {
+ "type": {
+ "$ref": "#/409"
+ },
+ "flags": 1,
+ "description": "The name of the aggregation function to use."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PreTaxCostUSD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CostUSD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PreTaxCost"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/403"
+ },
+ {
+ "$ref": "#/404"
+ },
+ {
+ "$ref": "#/405"
+ },
+ {
+ "$ref": "#/406"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sum"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/408"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDatasetAggregation",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/402"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items."
+ },
+ "or": {
+ "type": {
+ "$ref": "#/413"
+ },
+ "flags": 0,
+ "description": "The logical \"OR\" expression. Must have at least 2 items."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/414"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/414"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/411"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/411"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/416"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/415"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastResult",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 0,
+ "description": "Forecast properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Id."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Location of the resource."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "SKU of the resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ETag of the resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/424"
+ },
+ "flags": 2,
+ "description": "Resource tags."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastProperties",
+ "properties": {
+ "nextLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The link (url) to the next page of results."
+ },
+ "columns": {
+ "type": {
+ "$ref": "#/421"
+ },
+ "flags": 0,
+ "description": "Array of columns"
+ },
+ "rows": {
+ "type": {
+ "$ref": "#/423"
+ },
+ "flags": 0,
+ "description": "Array of rows"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastColumn",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of column."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The type of column."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/420"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/365"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/422"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostManagementResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "forecast",
+ "resourceType": "Microsoft.CostManagement/externalSubscriptions",
+ "apiVersion": "2024-10-01-preview",
+ "output": {
+ "$ref": "#/418"
+ },
+ "input": {
+ "$ref": "#/388"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/435"
+ },
+ "flags": 1,
+ "description": "The type of the query."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/443"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the query."
+ },
+ "dataset": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 1,
+ "description": "Has definition for data in this query."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FocusCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PriceSheet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationTransactions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationRecommendations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationDetails"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/427"
+ },
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/429"
+ },
+ {
+ "$ref": "#/430"
+ },
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastBillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WeekToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheCurrentMonth"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/436"
+ },
+ {
+ "$ref": "#/437"
+ },
+ {
+ "$ref": "#/438"
+ },
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/440"
+ },
+ {
+ "$ref": "#/441"
+ },
+ {
+ "$ref": "#/442"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date to pull data from."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date to pull data to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/448"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the query."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/449"
+ },
+ "flags": 0,
+ "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided."
+ },
+ "aggregation": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 0,
+ "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses."
+ },
+ "grouping": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 0,
+ "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/460"
+ },
+ "flags": 0,
+ "description": "The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/446"
+ },
+ {
+ "$ref": "#/447"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/450"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryAggregation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to aggregate."
+ },
+ "function": {
+ "type": {
+ "$ref": "#/453"
+ },
+ "flags": 1,
+ "description": "The name of the aggregation function to use."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sum"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/452"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDatasetAggregation",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/451"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryGrouping",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/458"
+ },
+ "flags": 1,
+ "description": "Has type of the column to group."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to group."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TagKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/456"
+ },
+ {
+ "$ref": "#/457"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/455"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items."
+ },
+ "or": {
+ "type": {
+ "$ref": "#/462"
+ },
+ "flags": 0,
+ "description": "The logical \"OR\" expression. Must have at least 2 items."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/460"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/460"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/465"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/466"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/464"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryResult",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/468"
+ },
+ "flags": 0,
+ "description": "Query properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Id."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Location of the resource."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "SKU of the resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ETag of the resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 2,
+ "description": "Resource tags."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryProperties",
+ "properties": {
+ "nextLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The link (url) to the next page of results."
+ },
+ "columns": {
+ "type": {
+ "$ref": "#/470"
+ },
+ "flags": 0,
+ "description": "Array of columns"
+ },
+ "rows": {
+ "type": {
+ "$ref": "#/472"
+ },
+ "flags": 0,
+ "description": "Array of rows"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryColumn",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of column."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The type of column."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/469"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/365"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/471"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostManagementResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "query",
+ "resourceType": "Microsoft.CostManagement/externalSubscriptions",
+ "apiVersion": "2024-10-01-preview",
+ "output": {
+ "$ref": "#/467"
+ },
+ "input": {
+ "$ref": "#/426"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "forecast",
+ "resourceType": "Microsoft.CostManagement/externalBillingAccounts",
+ "apiVersion": "2024-10-01-preview",
+ "output": {
+ "$ref": "#/418"
+ },
+ "input": {
+ "$ref": "#/388"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "query",
+ "resourceType": "Microsoft.CostManagement/externalBillingAccounts",
+ "apiVersion": "2024-10-01-preview",
+ "output": {
+ "$ref": "#/467"
+ },
+ "input": {
+ "$ref": "#/426"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DownloadURL",
+ "properties": {
+ "expiryTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z."
+ },
+ "validTill": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z."
+ },
+ "downloadUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL to download the generated report."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "download",
+ "resourceType": "Microsoft.CostManagement/pricesheets",
+ "apiVersion": "2024-10-01-preview",
+ "output": {
+ "$ref": "#/477"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "execute",
+ "resourceType": "Microsoft.CostManagement/scheduledActions",
+ "apiVersion": "2024-10-01-preview"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/cost-management/microsoft.costmanagement/2025-03-01/types.json b/internal/azure/generated/cost-management/microsoft.costmanagement/2025-03-01/types.json
new file mode 100644
index 000000000..d40d1c7fb
--- /dev/null
+++ b/internal/azure/generated/cost-management/microsoft.costmanagement/2025-03-01/types.json
@@ -0,0 +1,5688 @@
+[
+ {
+ "$type": "StringType",
+ "pattern": "[A-Za-z0-9\\-_]+"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/costAllocationRules"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/costAllocationRules",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Cost allocation rule properties"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostAllocationRuleProperties",
+ "properties": {
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Description of a cost allocation rule."
+ },
+ "details": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 1,
+ "description": "Resource information for the cost allocation rule"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 1,
+ "description": "Status of the rule"
+ },
+ "createdDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation."
+ },
+ "updatedDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Time at which the rule was last updated."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostAllocationRuleDetails",
+ "properties": {
+ "sourceResources": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Source resources for cost allocation. At this time, this list can contain no more than one element."
+ },
+ "targetResources": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 0,
+ "description": "Target resources for cost allocation. At this time, this list can contain no more than one element."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceCostAllocationResource",
+ "properties": {
+ "values": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 1,
+ "description": "Source Resources for cost allocation. This list cannot contain more than 25 values."
+ },
+ "resourceType": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 1,
+ "description": "Type of resources contained in this cost allocation rule"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tag"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/7"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TargetCostAllocationResource",
+ "properties": {
+ "values": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 1,
+ "description": "Target resources for cost allocation. This list cannot contain more than 25 values."
+ },
+ "policyType": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 1,
+ "description": "Method of cost allocation for the rule"
+ },
+ "resourceType": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 1,
+ "description": "Type of resources contained in this cost allocation rule"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostAllocationProportion",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Target resource for cost allocation"
+ },
+ "percentage": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 1,
+ "description": "Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/14"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FixedProportion"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tag"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/13"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotActive"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Processing"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/23"
+ },
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/costAllocationRules@2025-03-01",
+ "scopeType": 16,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9_-]+$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/budgets"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/budgets",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 0,
+ "description": "The properties of the budget."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetProperties",
+ "properties": {
+ "category": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 1,
+ "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule."
+ },
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "The total amount of cost to track with the budget.\n\n Supported for CategoryType(s): Cost.\n\n Required for CategoryType(s): Cost."
+ },
+ "timeGrain": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 1,
+ "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported timeGrainTypes for **CategoryType: Cost**\n\n- Monthly\n- Quarterly\n- Annually\n- BillingMonth*\n- BillingQuarter*\n- BillingAnnual*\n\n *only supported for Web Direct customers.\n\n Supported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\n Required for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 1,
+ "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "currentSpend": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 2,
+ "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost."
+ },
+ "notifications": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Dictionary of notifications associated with the budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n- Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.\n- Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable."
+ },
+ "forecastSpend": {
+ "type": {
+ "$ref": "#/94"
+ },
+ "flags": 2,
+ "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationUtilization"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Quarterly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Annually"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingQuarter"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingAnnual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last7Days"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last30Days"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetTimePeriod",
+ "properties": {
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date for the budget.\n\n- Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.\n\n- Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date."
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end date for the budget.\n\n- Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date.\n\n- Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items.\n\n Supported for CategoryType(s): Cost."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetFilterProperties",
+ "properties": {
+ "dimensions": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/50"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/47"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CurrentSpend",
+ "properties": {
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 2,
+ "description": "The total amount of cost which is being tracked by the budget."
+ },
+ "unit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unit of measure for the budget amount."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Notification",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 1,
+ "description": "The notification is enabled or not.\n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 1,
+ "description": "The comparison operator.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\n Supported operators for **CategoryType: ReservationUtilization**\n- LessThan"
+ },
+ "threshold": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 1,
+ "description": "Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n **CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold.\n\n **CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold."
+ },
+ "frequency": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 0,
+ "description": "Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).\n\n Supported for CategoryType(s): ReservationUtilization."
+ },
+ "contactEmails": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 1,
+ "description": "Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.\n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ },
+ "contactRoles": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 0,
+ "description": "Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.\n\n Supported for CategoryType(s): Cost."
+ },
+ "contactGroups": {
+ "type": {
+ "$ref": "#/67"
+ },
+ "flags": 0,
+ "description": "Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id.\n\n Supported for CategoryType(s): Cost."
+ },
+ "thresholdType": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 0,
+ "description": "The type of threshold.\n\n Supported for CategoryType(s): Cost."
+ },
+ "locale": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "Language in which the recipient will receive the notification, \n\n Supported for CategoryType(s): Cost, ReservationUtilization."
+ }
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThan"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThanOrEqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LessThan"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/57"
+ },
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/59"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Weekly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 50
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "maxLength": 50
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Actual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Forecasted"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "en-us"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ja-jp"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "zh-cn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "de-de"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "es-es"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "fr-fr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "it-it"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ko-kr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pt-br"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ru-ru"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "zh-tw"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cs-cz"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pl-pl"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "tr-tr"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "da-dk"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "en-gb"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "hu-hu"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "nb-no"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "nl-nl"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "pt-pt"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "sv-se"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/74"
+ },
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/81"
+ },
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/88"
+ },
+ {
+ "$ref": "#/89"
+ },
+ {
+ "$ref": "#/90"
+ },
+ {
+ "$ref": "#/91"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BudgetPropertiesNotifications",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/54"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastSpend",
+ "properties": {
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 2,
+ "description": "The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type."
+ },
+ "unit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unit of measure for the budget amount."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/budgets@2025-03-01",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/31"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/exports"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/exports",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/97"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/99"
+ },
+ "flags": 0,
+ "description": "The managed identity associated with Export"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The location of the Export's managed identity. Only required when utilizing managed identity."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 0,
+ "description": "The properties of the export."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemAssignedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/103"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (either system assigned, or none)."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportProperties",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 0,
+ "description": "Has schedule information for the export."
+ },
+ "format": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "The format of the export being delivered."
+ },
+ "deliveryInfo": {
+ "type": {
+ "$ref": "#/118"
+ },
+ "flags": 1,
+ "description": "Has delivery information for the export."
+ },
+ "definition": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 1,
+ "description": "Has the definition for the export."
+ },
+ "runHistory": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 0,
+ "description": "If requested, has the most recent run history for the export."
+ },
+ "partitionData": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file."
+ },
+ "dataOverwriteBehavior": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 0,
+ "description": "Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport."
+ },
+ "compressionMode": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 0,
+ "description": "Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet."
+ },
+ "exportDescription": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The export description set by customer at time of export creation/update."
+ },
+ "nextRunTimeEstimate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If the export has an active schedule, provides an estimate of the next run time."
+ },
+ "systemSuspensionContext": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 2,
+ "description": "The export suspension reason if export is in SystemSuspended state. This is not populated currently."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportSchedule",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 0,
+ "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused. To enable export set the status to be Active and then make a PUT request."
+ },
+ "recurrence": {
+ "type": {
+ "$ref": "#/113"
+ },
+ "flags": 0,
+ "description": "The schedule recurrence."
+ },
+ "recurrencePeriod": {
+ "type": {
+ "$ref": "#/114"
+ },
+ "flags": 0,
+ "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Inactive"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/106"
+ },
+ {
+ "$ref": "#/107"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Weekly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Annually"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/109"
+ },
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRecurrencePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date of recurrence."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end date of recurrence."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Csv"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Parquet"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/115"
+ },
+ {
+ "$ref": "#/116"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDeliveryInfo",
+ "properties": {
+ "destination": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 1,
+ "description": "Has destination for the export being delivered."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDeliveryDestination",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The export delivery destination type. Currently only 'AzureBlob' is supported."
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified."
+ },
+ "container": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the container where exports will be uploaded. If the container does not exist it will be created."
+ },
+ "rootFolderPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the directory where exports will be uploaded."
+ },
+ "sasToken": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 0,
+ "description": "A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified."
+ },
+ "storageAccount": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBlob"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/120"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 1,
+ "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the export."
+ },
+ "dataSet": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 0,
+ "description": "The definition for data in the export."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FocusCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PriceSheet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationTransactions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationRecommendations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationDetails"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/124"
+ },
+ {
+ "$ref": "#/125"
+ },
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/128"
+ },
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/130"
+ },
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastBillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WeekToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheCurrentMonth"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/134"
+ },
+ {
+ "$ref": "#/135"
+ },
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/137"
+ },
+ {
+ "$ref": "#/138"
+ },
+ {
+ "$ref": "#/139"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date for export data."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date for export data."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/145"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the export. Currently 'Daily' is supported for most cases."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 0,
+ "description": "The export dataset configuration."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/144"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples)."
+ },
+ "dataVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The data version for the selected for the export. If not provided then the export will default to latest data version."
+ },
+ "filters": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 0,
+ "description": "Filters associated with the data sets."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FilterItems",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 0,
+ "description": "The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType']"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Value to filter by. Currently values supported per name are, for 'ReservationScope' supported values are ['Single', 'Shared'], for 'LookBackPeriod' supported values are ['Last7Days', 'Last30Days', 'Last60Days'] and for 'ResourceType' supported values are ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple']."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationScope"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ResourceType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LookBackPeriod"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/148"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportExecutionListResult",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 2,
+ "description": "A list of export runs."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRun",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/156"
+ },
+ "flags": 0,
+ "description": "The properties of the export run."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Id."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRunProperties",
+ "properties": {
+ "executionType": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 0,
+ "description": "The type of the export run."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/167"
+ },
+ "flags": 0,
+ "description": "The last known status of the export run."
+ },
+ "submittedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'."
+ },
+ "submittedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when export was queued to be run."
+ },
+ "processingStartTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when export was picked up to be run."
+ },
+ "processingEndTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when the export run finished."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The start datetime for the export."
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The end datetime for the export."
+ },
+ "fileName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the exported file."
+ },
+ "manifestFile": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The manifest file location(URI location) for the exported files."
+ },
+ "runSettings": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 0,
+ "description": "The export settings that were in effect for this run."
+ },
+ "error": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 0,
+ "description": "The details of any error."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OnDemand"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Scheduled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Queued"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Timeout"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NewDataNotAvailable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DataNotAvailable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/162"
+ },
+ {
+ "$ref": "#/163"
+ },
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/165"
+ },
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CommonExportProperties",
+ "properties": {
+ "format": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 0,
+ "description": "The format of the export being delivered."
+ },
+ "deliveryInfo": {
+ "type": {
+ "$ref": "#/118"
+ },
+ "flags": 1,
+ "description": "Has delivery information for the export."
+ },
+ "definition": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 1,
+ "description": "Has the definition for the export."
+ },
+ "runHistory": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 0,
+ "description": "If requested, has the most recent run history for the export."
+ },
+ "partitionData": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file."
+ },
+ "dataOverwriteBehavior": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 0,
+ "description": "Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport."
+ },
+ "compressionMode": {
+ "type": {
+ "$ref": "#/178"
+ },
+ "flags": 0,
+ "description": "Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet."
+ },
+ "exportDescription": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The export description set by customer at time of export creation/update."
+ },
+ "nextRunTimeEstimate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If the export has an active schedule, provides an estimate of the next run time."
+ },
+ "systemSuspensionContext": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 2,
+ "description": "The export suspension reason if export is in SystemSuspended state. This is not populated currently."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Csv"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Parquet"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/169"
+ },
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwritePreviousReport"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateNewReport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "gzip"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "snappy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/176"
+ },
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportSuspensionContext",
+ "properties": {
+ "suspensionCode": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The code for export suspension."
+ },
+ "suspensionReason": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The detailed reason for export suspension."
+ },
+ "suspensionTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time when the export was suspended."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ErrorDetails",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Error code."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Error message indicating why the operation failed."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/155"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OverwritePreviousReport"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateNewReport"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/183"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "gzip"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "snappy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "none"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/185"
+ },
+ {
+ "$ref": "#/186"
+ },
+ {
+ "$ref": "#/187"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/exports@2025-03-01",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/98"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/views"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/views",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/193"
+ },
+ "flags": 0,
+ "description": "The properties of the view."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ViewProperties",
+ "properties": {
+ "displayName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User input name of the view. Required."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope."
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Date the user created this view."
+ },
+ "modifiedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date when the user last modified this view."
+ },
+ "dateRange": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date range of the current view."
+ },
+ "currency": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Currency of the current view."
+ },
+ "query": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "Query body configuration. Required."
+ },
+ "chart": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Chart type of the main view in Cost Analysis. Required."
+ },
+ "accumulated": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 0,
+ "description": "Show costs accumulated over time."
+ },
+ "metric": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 0,
+ "description": "Metric to use when displaying costs."
+ },
+ "kpis": {
+ "type": {
+ "$ref": "#/248"
+ },
+ "flags": 0,
+ "description": "List of KPIs to show in Cost Analysis UI."
+ },
+ "pivots": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "Configuration of 3 sub-views in the Cost Analysis UI."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 1,
+ "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/202"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the report."
+ },
+ "dataSet": {
+ "type": {
+ "$ref": "#/203"
+ },
+ "flags": 0,
+ "description": "Has definition for data in this report config."
+ },
+ "includeMonetaryCommitment": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "If true, report includes monetary commitment."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/195"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WeekToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "YearToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/197"
+ },
+ {
+ "$ref": "#/198"
+ },
+ {
+ "$ref": "#/199"
+ },
+ {
+ "$ref": "#/200"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date to pull data from."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date to pull data to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the report."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided."
+ },
+ "aggregation": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 0,
+ "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses."
+ },
+ "grouping": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 0,
+ "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses."
+ },
+ "sorting": {
+ "type": {
+ "$ref": "#/222"
+ },
+ "flags": 0,
+ "description": "Array of order by expression to use in the report."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Has filter expression to use in the report."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/208"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigAggregation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to aggregate."
+ },
+ "function": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 1,
+ "description": "The name of the aggregation function to use."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sum"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigDatasetAggregation",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/209"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigGrouping",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/216"
+ },
+ "flags": 1,
+ "description": "Has type of the column to group."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to group. This version supports subscription lowest possible grain."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TagKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/214"
+ },
+ {
+ "$ref": "#/215"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/213"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigSorting",
+ "properties": {
+ "direction": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "Direction of sort."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to sort."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ascending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Descending"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/219"
+ },
+ {
+ "$ref": "#/220"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/218"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/224"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items."
+ },
+ "or": {
+ "type": {
+ "$ref": "#/225"
+ },
+ "flags": 0,
+ "description": "The logical \"OR\" expression. Must have at least 2 items."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/223"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportConfigComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Contains"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/227"
+ },
+ {
+ "$ref": "#/228"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Area"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Line"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StackedColumn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GroupedColumn"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Table"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/231"
+ },
+ {
+ "$ref": "#/232"
+ },
+ {
+ "$ref": "#/233"
+ },
+ {
+ "$ref": "#/234"
+ },
+ {
+ "$ref": "#/235"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "true"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "false"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/237"
+ },
+ {
+ "$ref": "#/238"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AHUB"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/240"
+ },
+ {
+ "$ref": "#/241"
+ },
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KpiProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/247"
+ },
+ "flags": 0,
+ "description": "KPI type (Forecast, Budget)."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "ID of resource related to metric (budget)."
+ },
+ "enabled": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "show the KPI in the UI?"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Forecast"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Budget"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/245"
+ },
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/244"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PivotProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 0,
+ "description": "Data type to show in view."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data field to show in view."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TagKey"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/250"
+ },
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/249"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/views@2025-03-01",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/192"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/scheduledActions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/scheduledActions",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/258"
+ },
+ "flags": 0,
+ "description": "The properties of the scheduled action."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Etag. For update calls, eTag is optional and can be specified to achieve optimistic concurrency. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "Kind of the scheduled action."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/294"
+ },
+ "flags": 2,
+ "description": "Kind of the scheduled action."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduledActionProperties",
+ "properties": {
+ "displayName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Scheduled action name."
+ },
+ "fileDestination": {
+ "type": {
+ "$ref": "#/259"
+ },
+ "flags": 0,
+ "description": "Destination format of the view data. This is optional."
+ },
+ "notification": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 1,
+ "description": "Notification properties based on scheduled action kind."
+ },
+ "notificationEmail": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails."
+ },
+ "schedule": {
+ "type": {
+ "$ref": "#/266"
+ },
+ "flags": 1,
+ "description": "Schedule of the scheduled action."
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "For private scheduled action(Create or Update), scope will be empty. For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 1,
+ "description": "Status of the scheduled action."
+ },
+ "viewId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileDestination",
+ "properties": {
+ "fileFormats": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 0,
+ "description": "Destination of the view data. Currently only CSV format is supported."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Csv"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/260"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/261"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NotificationProperties",
+ "properties": {
+ "to": {
+ "type": {
+ "$ref": "#/265"
+ },
+ "flags": 1,
+ "description": "Array of email addresses."
+ },
+ "language": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Locale of the email."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Optional message to be added in the email. Length is limited to 250 characters."
+ },
+ "regionalFormat": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Regional format used for formatting date/time and currency values in the email."
+ },
+ "subject": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Subject of the email. Length is limited to 70 characters."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/264"
+ },
+ "minLength": 1,
+ "maxLength": 20
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduleProperties",
+ "properties": {
+ "frequency": {
+ "type": {
+ "$ref": "#/270"
+ },
+ "flags": 1,
+ "description": "Frequency of the schedule."
+ },
+ "hourOfDay": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "UTC time at which cost analysis data will be emailed."
+ },
+ "daysOfWeek": {
+ "type": {
+ "$ref": "#/279"
+ },
+ "flags": 0,
+ "description": "Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly."
+ },
+ "weeksOfMonth": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 0,
+ "description": "Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek."
+ },
+ "dayOfMonth": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek."
+ },
+ "startDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date and time of the scheduled action (UTC)."
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date and time of the scheduled action (UTC)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Weekly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/267"
+ },
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/269"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/272"
+ },
+ {
+ "$ref": "#/273"
+ },
+ {
+ "$ref": "#/274"
+ },
+ {
+ "$ref": "#/275"
+ },
+ {
+ "$ref": "#/276"
+ },
+ {
+ "$ref": "#/277"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/278"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/281"
+ },
+ {
+ "$ref": "#/282"
+ },
+ {
+ "$ref": "#/283"
+ },
+ {
+ "$ref": "#/284"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/285"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Expired"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/287"
+ },
+ {
+ "$ref": "#/288"
+ },
+ {
+ "$ref": "#/289"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Email"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InsightAlert"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/291"
+ },
+ {
+ "$ref": "#/292"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/304"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/296"
+ },
+ {
+ "$ref": "#/297"
+ },
+ {
+ "$ref": "#/298"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/300"
+ },
+ {
+ "$ref": "#/301"
+ },
+ {
+ "$ref": "#/302"
+ },
+ {
+ "$ref": "#/303"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/scheduledActions@2025-03-01",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/257"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "taginheritance"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/306"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/settings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "Microsoft.CostManagement/settings",
+ "discriminator": "kind",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ }
+ },
+ "elements": {
+ "taginheritance": {
+ "$ref": "#/311"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TagInheritanceSetting",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/312"
+ },
+ "flags": 0,
+ "description": "The properties of the tag inheritance setting."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 1,
+ "description": "Specifies the kind of settings."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TagInheritanceProperties",
+ "properties": {
+ "preferContainerTags": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 1,
+ "description": "This property defines the behavior when an inherited tag being applied matches a lower scope tag (Eg. Subscription tag matches the resource tag). If set to true - when tags match, the highest scope tags will be applied. Billing profile is the highest scope, followed by invoice sections, subscriptions and resource groups (allows overriding of lower scope tag values). If set to false - when tags match, the lowest scope tags will be applied. So, if a resource has the same tag as a subscription tag, the resource tag will be applied (does not allow overriding of lower scope tag values)."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "taginheritance"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/settings@2025-03-01",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/310"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.CostManagement/alerts"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.CostManagement/alerts",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/315"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 2,
+ "description": "Alert properties."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AlertProperties",
+ "properties": {
+ "definition": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "defines the type of alert"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Alert description"
+ },
+ "source": {
+ "type": {
+ "$ref": "#/350"
+ },
+ "flags": 0,
+ "description": "Source of alert"
+ },
+ "details": {
+ "type": {
+ "$ref": "#/351"
+ },
+ "flags": 0,
+ "description": "Alert details"
+ },
+ "costEntityId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "related budget"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/379"
+ },
+ "flags": 0,
+ "description": "alert status"
+ },
+ "creationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which alert was created"
+ },
+ "closeTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which alert was closed"
+ },
+ "modificationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which alert was last modified"
+ },
+ "statusModificationUserName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User who last modified the alert"
+ },
+ "statusModificationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "dateTime in which the alert status was last modified"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AlertPropertiesDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/327"
+ },
+ "flags": 0,
+ "description": "type of alert"
+ },
+ "category": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 0,
+ "description": "Alert category"
+ },
+ "criteria": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 0,
+ "description": "Criteria that triggered alert"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Budget"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invoice"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Credit"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Quota"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "General"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "xCloud"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BudgetForecast"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/320"
+ },
+ {
+ "$ref": "#/321"
+ },
+ {
+ "$ref": "#/322"
+ },
+ {
+ "$ref": "#/323"
+ },
+ {
+ "$ref": "#/324"
+ },
+ {
+ "$ref": "#/325"
+ },
+ {
+ "$ref": "#/326"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Billing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "System"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/329"
+ },
+ {
+ "$ref": "#/330"
+ },
+ {
+ "$ref": "#/331"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CostThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UsageThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreditThresholdApproaching"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreditThresholdReached"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "QuotaThresholdApproaching"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "QuotaThresholdReached"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiCurrency"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForecastCostThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForecastUsageThresholdExceeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InvoiceDueDateApproaching"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InvoiceDueDateReached"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CrossCloudNewDataAvailable"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CrossCloudCollectionError"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GeneralThresholdError"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/333"
+ },
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/335"
+ },
+ {
+ "$ref": "#/336"
+ },
+ {
+ "$ref": "#/337"
+ },
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/340"
+ },
+ {
+ "$ref": "#/341"
+ },
+ {
+ "$ref": "#/342"
+ },
+ {
+ "$ref": "#/343"
+ },
+ {
+ "$ref": "#/344"
+ },
+ {
+ "$ref": "#/345"
+ },
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Preset"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AlertPropertiesDetails",
+ "properties": {
+ "timeGrainType": {
+ "type": {
+ "$ref": "#/359"
+ },
+ "flags": 0,
+ "description": "Type of timegrain cadence"
+ },
+ "periodStartDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "datetime of periodStartDate"
+ },
+ "triggeredBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "notificationId that triggered this alert"
+ },
+ "resourceGroupFilter": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "array of resourceGroups to filter by"
+ },
+ "resourceFilter": {
+ "type": {
+ "$ref": "#/362"
+ },
+ "flags": 0,
+ "description": "array of resources to filter by"
+ },
+ "meterFilter": {
+ "type": {
+ "$ref": "#/363"
+ },
+ "flags": 0,
+ "description": "array of meters to filter by"
+ },
+ "tagFilter": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 0,
+ "description": "tags to filter by"
+ },
+ "threshold": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "notification threshold percentage as a decimal which activated this alert"
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 0,
+ "description": "operator used to compare currentSpend with amount"
+ },
+ "amount": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "budget threshold amount"
+ },
+ "unit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "unit of currency being used"
+ },
+ "currentSpend": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "current spend"
+ },
+ "contactEmails": {
+ "type": {
+ "$ref": "#/371"
+ },
+ "flags": 0,
+ "description": "list of emails to contact"
+ },
+ "contactGroups": {
+ "type": {
+ "$ref": "#/372"
+ },
+ "flags": 0,
+ "description": "list of action groups to broadcast to"
+ },
+ "contactRoles": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 0,
+ "description": "list of contact roles"
+ },
+ "overridingAlert": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "overriding alert"
+ },
+ "departmentName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "department name"
+ },
+ "companyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "company name"
+ },
+ "enrollmentNumber": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "enrollment number"
+ },
+ "enrollmentStartDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "datetime of enrollmentStartDate"
+ },
+ "enrollmentEndDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "datetime of enrollmentEndDate"
+ },
+ "invoicingThreshold": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 0,
+ "description": "invoicing threshold"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Quarterly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Annually"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingQuarter"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingAnnual"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/353"
+ },
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/355"
+ },
+ {
+ "$ref": "#/356"
+ },
+ {
+ "$ref": "#/357"
+ },
+ {
+ "$ref": "#/358"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/360"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/360"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/360"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThan"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GreaterThanOrEqualTo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LessThan"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LessThanOrEqualTo"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/364"
+ },
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/366"
+ },
+ {
+ "$ref": "#/367"
+ },
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Active"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Overridden"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Resolved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dismissed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/374"
+ },
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/376"
+ },
+ {
+ "$ref": "#/377"
+ },
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.CostManagement/alerts@2025-03-01",
+ "scopeType": 0,
+ "body": {
+ "$ref": "#/317"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExportRunRequest",
+ "properties": {
+ "timePeriod": {
+ "type": {
+ "$ref": "#/141"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the export."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "run",
+ "resourceType": "Microsoft.CostManagement/exports",
+ "apiVersion": "2025-03-01",
+ "input": {
+ "$ref": "#/381"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/387"
+ },
+ "flags": 1,
+ "description": "The type of the forecast."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/389"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the forecast."
+ },
+ "dataset": {
+ "type": {
+ "$ref": "#/391"
+ },
+ "flags": 1,
+ "description": "Has definition for data in this forecast."
+ },
+ "includeActualCost": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "A boolean determining if actualCost will be included."
+ },
+ "includeFreshPartialCost": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "A boolean determining if FreshPartialCost will be included."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/384"
+ },
+ {
+ "$ref": "#/385"
+ },
+ {
+ "$ref": "#/386"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/388"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date to pull data from."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date to pull data to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/394"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the forecast."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/395"
+ },
+ "flags": 0,
+ "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided."
+ },
+ "aggregation": {
+ "type": {
+ "$ref": "#/405"
+ },
+ "flags": 1,
+ "description": "Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/406"
+ },
+ "flags": 0,
+ "description": "Has filter expression to use in the forecast."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/392"
+ },
+ {
+ "$ref": "#/393"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/396"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastAggregation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/402"
+ },
+ "flags": 1,
+ "description": "The name of the column to aggregate."
+ },
+ "function": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 1,
+ "description": "The name of the aggregation function to use."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PreTaxCostUSD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CostUSD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PreTaxCost"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/398"
+ },
+ {
+ "$ref": "#/399"
+ },
+ {
+ "$ref": "#/400"
+ },
+ {
+ "$ref": "#/401"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sum"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/403"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastDatasetAggregation",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/397"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items."
+ },
+ "or": {
+ "type": {
+ "$ref": "#/408"
+ },
+ "flags": 0,
+ "description": "The logical \"OR\" expression. Must have at least 2 items."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/409"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/409"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/406"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/406"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/410"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastResult",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/414"
+ },
+ "flags": 0,
+ "description": "Forecast properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Id."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Location of the resource."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "SKU of the resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ETag of the resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 2,
+ "description": "Resource tags."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastProperties",
+ "properties": {
+ "nextLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The link (url) to the next page of results."
+ },
+ "columns": {
+ "type": {
+ "$ref": "#/416"
+ },
+ "flags": 0,
+ "description": "Array of columns"
+ },
+ "rows": {
+ "type": {
+ "$ref": "#/418"
+ },
+ "flags": 0,
+ "description": "Array of rows"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ForecastColumn",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of column."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The type of column."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/415"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/360"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/417"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostManagementResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "forecast",
+ "resourceType": "Microsoft.CostManagement/externalSubscriptions",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/413"
+ },
+ "input": {
+ "$ref": "#/383"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDefinition",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 1,
+ "description": "The type of the query."
+ },
+ "timeframe": {
+ "type": {
+ "$ref": "#/438"
+ },
+ "flags": 1,
+ "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided."
+ },
+ "timePeriod": {
+ "type": {
+ "$ref": "#/439"
+ },
+ "flags": 0,
+ "description": "Has time period for pulling data for the query."
+ },
+ "dataset": {
+ "type": {
+ "$ref": "#/440"
+ },
+ "flags": 1,
+ "description": "Has definition for data in this query."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Usage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActualCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AmortizedCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FocusCost"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PriceSheet"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationTransactions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationRecommendations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ReservationDetails"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/424"
+ },
+ {
+ "$ref": "#/425"
+ },
+ {
+ "$ref": "#/426"
+ },
+ {
+ "$ref": "#/427"
+ },
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/429"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BillingMonthToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheLastBillingMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WeekToDate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TheCurrentMonth"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/431"
+ },
+ {
+ "$ref": "#/432"
+ },
+ {
+ "$ref": "#/433"
+ },
+ {
+ "$ref": "#/434"
+ },
+ {
+ "$ref": "#/435"
+ },
+ {
+ "$ref": "#/436"
+ },
+ {
+ "$ref": "#/437"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryTimePeriod",
+ "properties": {
+ "from": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The start date to pull data from."
+ },
+ "to": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The end date to pull data to."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDataset",
+ "properties": {
+ "granularity": {
+ "type": {
+ "$ref": "#/443"
+ },
+ "flags": 0,
+ "description": "The granularity of rows in the query."
+ },
+ "configuration": {
+ "type": {
+ "$ref": "#/444"
+ },
+ "flags": 0,
+ "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided."
+ },
+ "aggregation": {
+ "type": {
+ "$ref": "#/449"
+ },
+ "flags": 0,
+ "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses."
+ },
+ "grouping": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 0,
+ "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses."
+ },
+ "filter": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 0,
+ "description": "The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Daily"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monthly"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/441"
+ },
+ {
+ "$ref": "#/442"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDatasetConfiguration",
+ "properties": {
+ "columns": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 0,
+ "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryAggregation",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to aggregate."
+ },
+ "function": {
+ "type": {
+ "$ref": "#/448"
+ },
+ "flags": 1,
+ "description": "The name of the aggregation function to use."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sum"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/447"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryDatasetAggregation",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/446"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryGrouping",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/453"
+ },
+ "flags": 1,
+ "description": "Has type of the column to group."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to group."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TagKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dimension"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/451"
+ },
+ {
+ "$ref": "#/452"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/450"
+ },
+ "maxLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryFilter",
+ "properties": {
+ "and": {
+ "type": {
+ "$ref": "#/456"
+ },
+ "flags": 0,
+ "description": "The logical \"AND\" expression. Must have at least 2 items."
+ },
+ "or": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 0,
+ "description": "The logical \"OR\" expression. Must have at least 2 items."
+ },
+ "dimensions": {
+ "type": {
+ "$ref": "#/458"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a dimension"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/458"
+ },
+ "flags": 0,
+ "description": "Has comparison expression for a tag"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/455"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/455"
+ },
+ "minLength": 2
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryComparisonExpression",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the column to use in comparison."
+ },
+ "operator": {
+ "type": {
+ "$ref": "#/460"
+ },
+ "flags": 1,
+ "description": "The operator to use for comparison."
+ },
+ "values": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 1,
+ "description": "Array of values to use for comparison"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "In"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/459"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ },
+ "minLength": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryResult",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 0,
+ "description": "Query properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource Id."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Location of the resource."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "SKU of the resource."
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ETag of the resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/468"
+ },
+ "flags": 2,
+ "description": "Resource tags."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryProperties",
+ "properties": {
+ "nextLink": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The link (url) to the next page of results."
+ },
+ "columns": {
+ "type": {
+ "$ref": "#/465"
+ },
+ "flags": 0,
+ "description": "Array of columns"
+ },
+ "rows": {
+ "type": {
+ "$ref": "#/467"
+ },
+ "flags": 0,
+ "description": "Array of rows"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryColumn",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of column."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The type of column."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/464"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/360"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/466"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CostManagementResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "query",
+ "resourceType": "Microsoft.CostManagement/externalSubscriptions",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/462"
+ },
+ "input": {
+ "$ref": "#/421"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "forecast",
+ "resourceType": "Microsoft.CostManagement/externalBillingAccounts",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/413"
+ },
+ "input": {
+ "$ref": "#/383"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "query",
+ "resourceType": "Microsoft.CostManagement/externalBillingAccounts",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/462"
+ },
+ "input": {
+ "$ref": "#/421"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DownloadURL",
+ "properties": {
+ "expiryTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z."
+ },
+ "validTill": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z."
+ },
+ "downloadUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The URL to download the generated report."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "download",
+ "resourceType": "Microsoft.CostManagement/pricesheets",
+ "apiVersion": "2025-03-01",
+ "output": {
+ "$ref": "#/472"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "execute",
+ "resourceType": "Microsoft.CostManagement/scheduledActions",
+ "apiVersion": "2025-03-01"
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/databricks/microsoft.databricks/2025-03-01-preview/types.json b/internal/azure/generated/databricks/microsoft.databricks/2025-03-01-preview/types.json
new file mode 100644
index 000000000..8419ab461
--- /dev/null
+++ b/internal/azure/generated/databricks/microsoft.databricks/2025-03-01-preview/types.json
@@ -0,0 +1,2442 @@
+[
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 64
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Databricks/workspaces"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Databricks/workspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 1,
+ "description": "The workspace properties."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "The SKU of the resource."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceProperties",
+ "properties": {
+ "managedResourceGroupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The managed resource group Id."
+ },
+ "parameters": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "The workspace's custom parameters."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/49"
+ },
+ "flags": 2,
+ "description": "The workspace provisioning state."
+ },
+ "uiDefinitionUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The blob URI where the UI definition file is located."
+ },
+ "authorizations": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "The workspace provider authorizations."
+ },
+ "createdBy": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "Indicates the Object ID, PUID and Application ID of entity that created the workspace."
+ },
+ "updatedBy": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "Indicates the Object ID, PUID and Application ID of entity that last updated the workspace."
+ },
+ "createdDateTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Specifies the date and time when the workspace is created."
+ },
+ "workspaceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The unique identifier of the databricks workspace in databricks control plane."
+ },
+ "workspaceUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'"
+ },
+ "storageAccountIdentity": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "The details of Managed Identity of Storage Account"
+ },
+ "managedDiskIdentity": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption"
+ },
+ "diskEncryptionSetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource Id of the managed disk encryption set."
+ },
+ "encryption": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "Encryption properties for databricks workspace"
+ },
+ "enhancedSecurityCompliance": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "Contains settings related to the Enhanced Security and Compliance Add-On."
+ },
+ "privateEndpointConnections": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 2,
+ "description": "Private endpoint connections created on the workspace"
+ },
+ "publicNetworkAccess": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 0,
+ "description": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link."
+ },
+ "requiredNsgRules": {
+ "type": {
+ "$ref": "#/112"
+ },
+ "flags": 0,
+ "description": "Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only."
+ },
+ "defaultCatalog": {
+ "type": {
+ "$ref": "#/113"
+ },
+ "flags": 0,
+ "description": "Properties for Default Catalog configuration during workspace creation."
+ },
+ "isUcEnabled": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 2,
+ "description": "Indicates whether unity catalog enabled for the workspace or not."
+ },
+ "accessConnector": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 0,
+ "description": "Access Connector Resource that is going to be associated with Databricks Workspace"
+ },
+ "defaultStorageFirewall": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 0,
+ "description": "Gets or Sets Default Storage Firewall configuration information"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceCustomParameters",
+ "properties": {
+ "amlWorkspaceId": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The ID of a Azure Machine Learning workspace to link with Databricks workspace"
+ },
+ "customVirtualNetworkId": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The ID of a Virtual Network where this Databricks Cluster should be created"
+ },
+ "customPublicSubnetName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The name of a Public Subnet within the Virtual Network"
+ },
+ "customPrivateSubnetName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The name of the Private Subnet within the Virtual Network"
+ },
+ "enableNoPublicIp": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Boolean indicating whether the public IP should be disabled. Default value is true"
+ },
+ "loadBalancerBackendPoolName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP)."
+ },
+ "loadBalancerId": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace."
+ },
+ "natGatewayName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets."
+ },
+ "publicIpName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Name of the Public IP for No Public IP workspace with managed vNet."
+ },
+ "prepareEncryption": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "Prepare the workspace for encryption. Enables the Managed Identity for managed storage account."
+ },
+ "encryption": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 0,
+ "description": "Contains the encryption details for Customer-Managed Key (CMK) enabled workspace."
+ },
+ "requireInfrastructureEncryption": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest."
+ },
+ "storageAccountName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Default DBFS storage account name."
+ },
+ "storageAccountSkuName": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs."
+ },
+ "vnetAddressPrefix": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Address prefix for Managed virtual network. Default value for this input is 10.139."
+ },
+ "resourceTags": {
+ "type": {
+ "$ref": "#/32"
+ },
+ "flags": 2,
+ "description": "Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceCustomStringParameter",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 2,
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The value which should be used for this field."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Bool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Object"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceNoPublicIPBooleanParameter",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 2,
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 1,
+ "description": "The value which should be used for this field."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Bool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Object"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/15"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceCustomBooleanParameter",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 2,
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 1,
+ "description": "The value which should be used for this field."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Bool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Object"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceEncryptionParameter",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "The value which should be used for this field."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Bool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Object"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/26"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Encryption",
+ "properties": {
+ "keySource": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 0,
+ "description": "The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault"
+ },
+ "KeyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of KeyVault key."
+ },
+ "keyversion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The version of KeyVault key."
+ },
+ "keyvaulturi": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Uri of KeyVault."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Keyvault"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/29"
+ },
+ {
+ "$ref": "#/30"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceCustomObjectParameter",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/36"
+ },
+ "flags": 2,
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/37"
+ },
+ "flags": 1,
+ "description": "The value which should be used for this field."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Bool"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Object"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "String"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ready"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Created"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspaceProviderAuthorization",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 1,
+ "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources."
+ },
+ "roleDefinitionId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 1,
+ "description": "The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/50"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CreatedBy",
+ "properties": {
+ "oid": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The Object ID that created the workspace."
+ },
+ "puid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The Personal Object ID corresponding to the object ID above"
+ },
+ "applicationId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The application ID of the application that initiated the creation of the workspace. For example, Azure Portal."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedIdentityConfiguration",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The objectId of the Managed Identity that is linked to the Managed Storage account."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The tenant Id where the Managed Identity is created."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of Identity created. It can be either SystemAssigned or UserAssigned."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspacePropertiesEncryption",
+ "properties": {
+ "entities": {
+ "type": {
+ "$ref": "#/56"
+ },
+ "flags": 1,
+ "description": "Encryption entities definition for the workspace."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionEntitiesDefinition",
+ "properties": {
+ "managedServices": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 0,
+ "description": "Encryption properties for the databricks managed services."
+ },
+ "managedDisk": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 0,
+ "description": "Encryption properties for the databricks managed disks."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionV2",
+ "properties": {
+ "keySource": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 1,
+ "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault"
+ },
+ "keyVaultProperties": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 0,
+ "description": "Key Vault input properties for encryption."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Keyvault"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionV2KeyVaultProperties",
+ "properties": {
+ "keyVaultUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The Uri of KeyVault."
+ },
+ "keyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of KeyVault key."
+ },
+ "keyVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The version of KeyVault key."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedDiskEncryption",
+ "properties": {
+ "keySource": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault"
+ },
+ "keyVaultProperties": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 1,
+ "description": "Key Vault input properties for encryption."
+ },
+ "rotationToLatestKeyVersionEnabled": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "Indicate whether the latest key version should be automatically used for Managed Disk Encryption."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Keyvault"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedDiskEncryptionKeyVaultProperties",
+ "properties": {
+ "keyVaultUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The URI of KeyVault."
+ },
+ "keyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of KeyVault key."
+ },
+ "keyVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The version of KeyVault key."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EnhancedSecurityComplianceDefinition",
+ "properties": {
+ "automaticClusterUpdate": {
+ "type": {
+ "$ref": "#/66"
+ },
+ "flags": 0,
+ "description": "Status of automated cluster updates feature."
+ },
+ "complianceSecurityProfile": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 0,
+ "description": "Status of Compliance Security Profile feature."
+ },
+ "enhancedSecurityMonitoring": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 0,
+ "description": "Status of Enhanced Security Monitoring feature."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AutomaticClusterUpdateDefinition",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ComplianceSecurityProfileDefinition",
+ "properties": {
+ "complianceStandards": {
+ "type": {
+ "$ref": "#/81"
+ },
+ "flags": 0,
+ "description": "Compliance standards associated with the workspace."
+ },
+ "value": {
+ "type": {
+ "$ref": "#/84"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NONE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "HIPAA"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PCI_DSS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CYBER_ESSENTIAL_PLUS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FEDRAMP_HIGH"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANADA_PROTECTED_B"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "IRAP_PROTECTED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ISMAP"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "HITRUST"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/74"
+ },
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/80"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EnhancedSecurityMonitoringDefinition",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/86"
+ },
+ {
+ "$ref": "#/87"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnection",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource identifier."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource type."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 1,
+ "description": "The private endpoint connection properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 0,
+ "description": "Private endpoint"
+ },
+ "groupIds": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "GroupIds from the private link service resource."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 1,
+ "description": "Private endpoint connection state"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/104"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the private endpoint connection."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The resource identifier."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 1,
+ "description": "The status of a private endpoint connection"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The description for the current state of a private endpoint connection"
+ },
+ "actionsRequired": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Actions required for a private endpoint connection"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/94"
+ },
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/96"
+ },
+ {
+ "$ref": "#/97"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/99"
+ },
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/89"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/106"
+ },
+ {
+ "$ref": "#/107"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllRules"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoAzureDatabricksRules"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NoAzureServiceRules"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/109"
+ },
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DefaultCatalogProperties",
+ "properties": {
+ "initialType": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 0,
+ "description": "Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog"
+ },
+ "initialName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "HiveMetastore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UnityCatalog"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/114"
+ },
+ {
+ "$ref": "#/115"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WorkspacePropertiesAccessConnector",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of Azure Databricks Access Connector Resource."
+ },
+ "identityType": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 1,
+ "description": "The identity type of the Access Connector Resource."
+ },
+ "userAssignedIdentityId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/121"
+ },
+ {
+ "$ref": "#/122"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Sku",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The SKU name."
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The SKU tier."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/135"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/128"
+ },
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/131"
+ },
+ {
+ "$ref": "#/132"
+ },
+ {
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/134"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Databricks/workspaces@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Databricks/workspaces/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Databricks/workspaces/privateEndpointConnections",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/139"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 1,
+ "description": "The private endpoint connection properties."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Databricks/workspaces/privateEndpointConnections@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/140"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Databricks/workspaces/virtualNetworkPeerings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/143"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/145"
+ },
+ "flags": 1,
+ "description": "List of properties for vNet Peering"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualNetworkPeeringPropertiesFormat",
+ "properties": {
+ "allowVirtualNetworkAccess": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space."
+ },
+ "allowForwardedTraffic": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network."
+ },
+ "allowGatewayTransit": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "If gateway links can be used in remote virtual networking to link to this virtual network."
+ },
+ "useRemoteGateways": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway."
+ },
+ "databricksVirtualNetwork": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 0,
+ "description": "The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)."
+ },
+ "databricksAddressSpace": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The reference to the databricks virtual network address space."
+ },
+ "remoteVirtualNetwork": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 1,
+ "description": "The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)."
+ },
+ "remoteAddressSpace": {
+ "type": {
+ "$ref": "#/147"
+ },
+ "flags": 0,
+ "description": "The reference to the remote virtual network address space."
+ },
+ "peeringState": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 2,
+ "description": "The status of the virtual network peering."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/158"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the virtual network peering resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Id of the databricks virtual network."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AddressSpace",
+ "properties": {
+ "addressPrefixes": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "A list of address blocks reserved for this virtual network in CIDR notation."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Id of the remote virtual network."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initiated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Connected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disconnected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/152"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/154"
+ },
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ },
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/144"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Databricks/accessConnectors"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Databricks/accessConnectors",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/161"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "Managed service identity (system assigned and/or user assigned identities)"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 2,
+ "description": "The system metadata relating to this resource"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 0,
+ "description": "Azure Databricks Access Connector properties"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/168"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/170"
+ },
+ "flags": 0,
+ "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned,UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/165"
+ },
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The principal ID of the assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/51"
+ },
+ "flags": 2,
+ "description": "The client ID of the assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/169"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AccessConnectorProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 2,
+ "description": "Provisioning status of the Access Connector."
+ },
+ "referedBy": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 2,
+ "description": "List of workspaces referring this Access Connector."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ready"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Created"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/172"
+ },
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/176"
+ },
+ {
+ "$ref": "#/177"
+ },
+ {
+ "$ref": "#/178"
+ },
+ {
+ "$ref": "#/179"
+ },
+ {
+ "$ref": "#/180"
+ },
+ {
+ "$ref": "#/181"
+ },
+ {
+ "$ref": "#/182"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Databricks/accessConnectors@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/162"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.Databricks/workspaces/privateLinkResources"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.Databricks/workspaces/privateLinkResources",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/188"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 2,
+ "description": "The group id properties."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GroupIdInformationProperties",
+ "properties": {
+ "groupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The group id"
+ },
+ "requiredMembers": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 0,
+ "description": "The required members for a specific group id"
+ },
+ "requiredZoneNames": {
+ "type": {
+ "$ref": "#/192"
+ },
+ "flags": 0,
+ "description": "The required DNS zones for a specific group id"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.Databricks/workspaces/privateLinkResources@2025-03-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/189"
+ },
+ "flags": 1
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/datafactory/microsoft.datafactory/2018-06-01/types.json b/internal/azure/generated/datafactory/microsoft.datafactory/2018-06-01/types.json
index cb50bb3d4..96afba15c 100644
--- a/internal/azure/generated/datafactory/microsoft.datafactory/2018-06-01/types.json
+++ b/internal/azure/generated/datafactory/microsoft.datafactory/2018-06-01/types.json
@@ -2034,361 +2034,361 @@
"$ref": "#/159"
},
"AmazonRdsForSqlServer": {
- "$ref": "#/162"
+ "$ref": "#/164"
},
"AmazonRedshift": {
- "$ref": "#/173"
+ "$ref": "#/175"
},
"AmazonS3": {
- "$ref": "#/176"
+ "$ref": "#/178"
},
"AmazonS3Compatible": {
- "$ref": "#/179"
+ "$ref": "#/181"
},
"AppFigures": {
- "$ref": "#/182"
+ "$ref": "#/184"
},
"Asana": {
- "$ref": "#/185"
+ "$ref": "#/187"
},
"AzureBatch": {
- "$ref": "#/188"
+ "$ref": "#/190"
},
"AzureBlobFS": {
- "$ref": "#/191"
+ "$ref": "#/193"
},
"AzureBlobStorage": {
- "$ref": "#/194"
+ "$ref": "#/196"
},
"AzureDataExplorer": {
- "$ref": "#/204"
+ "$ref": "#/206"
},
"AzureDataLakeAnalytics": {
- "$ref": "#/207"
+ "$ref": "#/209"
},
"AzureDataLakeStore": {
- "$ref": "#/210"
+ "$ref": "#/212"
},
"AzureDatabricks": {
- "$ref": "#/213"
+ "$ref": "#/215"
},
"AzureDatabricksDeltaLake": {
- "$ref": "#/219"
+ "$ref": "#/221"
},
"AzureFileStorage": {
- "$ref": "#/222"
+ "$ref": "#/224"
},
"AzureFunction": {
- "$ref": "#/225"
+ "$ref": "#/227"
},
"AzureKeyVault": {
- "$ref": "#/228"
+ "$ref": "#/230"
},
"AzureML": {
- "$ref": "#/231"
+ "$ref": "#/233"
},
"AzureMLService": {
- "$ref": "#/234"
+ "$ref": "#/236"
},
"AzureMariaDB": {
- "$ref": "#/237"
+ "$ref": "#/239"
},
"AzureMySql": {
- "$ref": "#/240"
+ "$ref": "#/242"
},
"AzurePostgreSql": {
- "$ref": "#/243"
+ "$ref": "#/245"
},
"AzureSearch": {
- "$ref": "#/246"
+ "$ref": "#/248"
},
"AzureSqlDW": {
- "$ref": "#/249"
+ "$ref": "#/251"
},
"AzureSqlDatabase": {
- "$ref": "#/257"
+ "$ref": "#/259"
},
"AzureSqlMI": {
- "$ref": "#/265"
+ "$ref": "#/267"
},
"AzureStorage": {
- "$ref": "#/273"
+ "$ref": "#/275"
},
"AzureSynapseArtifacts": {
- "$ref": "#/276"
+ "$ref": "#/278"
},
"AzureTableStorage": {
- "$ref": "#/279"
+ "$ref": "#/281"
},
"Cassandra": {
- "$ref": "#/282"
+ "$ref": "#/284"
},
"CommonDataServiceForApps": {
- "$ref": "#/285"
+ "$ref": "#/287"
},
"Concur": {
- "$ref": "#/288"
+ "$ref": "#/290"
},
"CosmosDb": {
- "$ref": "#/291"
+ "$ref": "#/293"
},
"CosmosDbMongoDbApi": {
- "$ref": "#/297"
+ "$ref": "#/299"
},
"Couchbase": {
- "$ref": "#/300"
+ "$ref": "#/302"
},
"CustomDataSource": {
- "$ref": "#/303"
+ "$ref": "#/305"
},
"Dataworld": {
- "$ref": "#/305"
+ "$ref": "#/307"
},
"Db2": {
- "$ref": "#/308"
+ "$ref": "#/310"
},
"Drill": {
- "$ref": "#/313"
+ "$ref": "#/315"
},
"Dynamics": {
- "$ref": "#/316"
+ "$ref": "#/318"
},
"DynamicsAX": {
- "$ref": "#/319"
+ "$ref": "#/321"
},
"DynamicsCrm": {
- "$ref": "#/322"
+ "$ref": "#/324"
},
"Eloqua": {
- "$ref": "#/325"
+ "$ref": "#/327"
},
"FileServer": {
- "$ref": "#/328"
+ "$ref": "#/330"
},
"FtpServer": {
- "$ref": "#/331"
+ "$ref": "#/333"
},
"GoogleAdWords": {
- "$ref": "#/337"
+ "$ref": "#/339"
},
"GoogleBigQuery": {
- "$ref": "#/343"
+ "$ref": "#/345"
},
"GoogleBigQueryV2": {
- "$ref": "#/349"
+ "$ref": "#/351"
},
"GoogleCloudStorage": {
- "$ref": "#/355"
+ "$ref": "#/357"
},
"GoogleSheets": {
- "$ref": "#/358"
+ "$ref": "#/360"
},
"Greenplum": {
- "$ref": "#/361"
+ "$ref": "#/363"
},
"HBase": {
- "$ref": "#/366"
+ "$ref": "#/368"
},
"HDInsight": {
- "$ref": "#/372"
+ "$ref": "#/374"
},
"HDInsightOnDemand": {
- "$ref": "#/375"
+ "$ref": "#/377"
},
"Hdfs": {
- "$ref": "#/381"
+ "$ref": "#/383"
},
"Hive": {
- "$ref": "#/384"
+ "$ref": "#/386"
},
"HttpServer": {
- "$ref": "#/400"
+ "$ref": "#/402"
},
"Hubspot": {
- "$ref": "#/409"
+ "$ref": "#/411"
},
"Impala": {
- "$ref": "#/412"
+ "$ref": "#/414"
},
"Informix": {
- "$ref": "#/419"
+ "$ref": "#/424"
},
"Jira": {
- "$ref": "#/422"
+ "$ref": "#/427"
},
"Lakehouse": {
- "$ref": "#/425"
+ "$ref": "#/430"
},
"Magento": {
- "$ref": "#/428"
+ "$ref": "#/433"
},
"MariaDB": {
- "$ref": "#/431"
+ "$ref": "#/436"
},
"Marketo": {
- "$ref": "#/434"
+ "$ref": "#/439"
},
"MicrosoftAccess": {
- "$ref": "#/437"
+ "$ref": "#/442"
},
"MongoDb": {
- "$ref": "#/440"
+ "$ref": "#/445"
},
"MongoDbAtlas": {
- "$ref": "#/446"
+ "$ref": "#/451"
},
"MongoDbV2": {
- "$ref": "#/449"
+ "$ref": "#/454"
},
"MySql": {
- "$ref": "#/452"
+ "$ref": "#/457"
},
"Netezza": {
- "$ref": "#/455"
+ "$ref": "#/460"
},
"OData": {
- "$ref": "#/458"
+ "$ref": "#/463"
},
"Odbc": {
- "$ref": "#/470"
+ "$ref": "#/475"
},
"Office365": {
- "$ref": "#/473"
+ "$ref": "#/478"
},
"Oracle": {
- "$ref": "#/476"
+ "$ref": "#/481"
},
"OracleCloudStorage": {
- "$ref": "#/481"
+ "$ref": "#/486"
},
"OracleServiceCloud": {
- "$ref": "#/484"
+ "$ref": "#/489"
},
"Paypal": {
- "$ref": "#/487"
+ "$ref": "#/492"
},
"Phoenix": {
- "$ref": "#/490"
+ "$ref": "#/495"
},
"PostgreSql": {
- "$ref": "#/497"
+ "$ref": "#/502"
},
"PostgreSqlV2": {
- "$ref": "#/500"
+ "$ref": "#/505"
},
"Presto": {
- "$ref": "#/503"
+ "$ref": "#/508"
},
"QuickBooks": {
- "$ref": "#/509"
+ "$ref": "#/514"
},
"Quickbase": {
- "$ref": "#/512"
+ "$ref": "#/517"
},
"Responsys": {
- "$ref": "#/515"
+ "$ref": "#/520"
},
"RestService": {
- "$ref": "#/518"
+ "$ref": "#/523"
},
"Salesforce": {
- "$ref": "#/527"
+ "$ref": "#/532"
},
"SalesforceMarketingCloud": {
- "$ref": "#/530"
+ "$ref": "#/535"
},
"SalesforceServiceCloud": {
- "$ref": "#/533"
+ "$ref": "#/538"
},
"SalesforceServiceCloudV2": {
- "$ref": "#/536"
+ "$ref": "#/541"
},
"SalesforceV2": {
- "$ref": "#/539"
+ "$ref": "#/544"
},
"SapBW": {
- "$ref": "#/542"
+ "$ref": "#/547"
},
"SapCloudForCustomer": {
- "$ref": "#/545"
+ "$ref": "#/550"
},
"SapEcc": {
- "$ref": "#/548"
+ "$ref": "#/553"
},
"SapHana": {
- "$ref": "#/551"
+ "$ref": "#/556"
},
"SapOdp": {
- "$ref": "#/557"
+ "$ref": "#/562"
},
"SapOpenHub": {
- "$ref": "#/560"
+ "$ref": "#/565"
},
"SapTable": {
- "$ref": "#/563"
+ "$ref": "#/568"
},
"ServiceNow": {
- "$ref": "#/566"
+ "$ref": "#/571"
},
"ServiceNowV2": {
- "$ref": "#/572"
+ "$ref": "#/577"
},
"Sftp": {
- "$ref": "#/578"
+ "$ref": "#/583"
},
"SharePointOnlineList": {
- "$ref": "#/585"
+ "$ref": "#/590"
},
"Shopify": {
- "$ref": "#/588"
+ "$ref": "#/593"
},
"Smartsheet": {
- "$ref": "#/591"
+ "$ref": "#/596"
},
"Snowflake": {
- "$ref": "#/594"
+ "$ref": "#/599"
},
"SnowflakeV2": {
- "$ref": "#/597"
+ "$ref": "#/602"
},
"Spark": {
- "$ref": "#/604"
+ "$ref": "#/609"
},
"SqlServer": {
- "$ref": "#/620"
+ "$ref": "#/625"
},
"Square": {
- "$ref": "#/627"
+ "$ref": "#/632"
},
"Sybase": {
- "$ref": "#/630"
+ "$ref": "#/635"
},
"TeamDesk": {
- "$ref": "#/636"
+ "$ref": "#/641"
},
"Teradata": {
- "$ref": "#/642"
+ "$ref": "#/647"
},
"Twilio": {
- "$ref": "#/648"
+ "$ref": "#/653"
},
"Vertica": {
- "$ref": "#/651"
+ "$ref": "#/656"
},
"Warehouse": {
- "$ref": "#/654"
+ "$ref": "#/659"
},
"Web": {
- "$ref": "#/657"
+ "$ref": "#/662"
},
"Xero": {
- "$ref": "#/666"
+ "$ref": "#/671"
},
"Zendesk": {
- "$ref": "#/669"
+ "$ref": "#/674"
},
"Zoho": {
- "$ref": "#/675"
+ "$ref": "#/680"
}
}
},
@@ -2646,7 +2646,7 @@
},
"type": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/163"
},
"flags": 1,
"description": "Type of linked service."
@@ -2661,8 +2661,29 @@
"type": {
"$ref": "#/11"
},
- "flags": 1,
- "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
+ "flags": 0,
+ "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0."
+ },
+ "server": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "The location of AmazonRdsForOracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0."
+ },
+ "authenticationType": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0."
+ },
+ "username": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "The AmazonRdsForOracle database username. Type: string. Only used for Version 2.0."
},
"password": {
"type": {
@@ -2671,6 +2692,83 @@
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
},
+ "encryptionClient": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0."
+ },
+ "encryptionTypesClient": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0."
+ },
+ "cryptoChecksumClient": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0."
+ },
+ "cryptoChecksumTypesClient": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0."
+ },
+ "initialLobFetchSize": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0."
+ },
+ "fetchSize": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0."
+ },
+ "statementCacheSize": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0."
+ },
+ "initializationString": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0."
+ },
+ "enableBulkLoad": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0."
+ },
+ "supportV1DataTypes": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0."
+ },
+ "fetchTswtzAsTimestamp": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0."
+ },
"encryptedCredential": {
"type": {
"$ref": "#/2"
@@ -2680,6 +2778,21 @@
}
}
},
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
{
"$type": "StringLiteralType",
"value": "AmazonRdsForOracle"
@@ -2690,14 +2803,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/163"
+ "$ref": "#/165"
},
"flags": 1,
"description": "Amazon RDS for SQL Server linked service properties."
},
"type": {
"type": {
- "$ref": "#/172"
+ "$ref": "#/174"
},
"flags": 1,
"description": "Type of linked service."
@@ -2717,7 +2830,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/166"
+ "$ref": "#/168"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -2745,7 +2858,7 @@
},
"alwaysEncryptedSettings": {
"type": {
- "$ref": "#/167"
+ "$ref": "#/169"
},
"flags": 0,
"description": "Sql always encrypted properties."
@@ -2897,10 +3010,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/164"
+ "$ref": "#/166"
},
{
- "$ref": "#/165"
+ "$ref": "#/167"
},
{
"$ref": "#/2"
@@ -2913,7 +3026,7 @@
"properties": {
"alwaysEncryptedAkvAuthType": {
"type": {
- "$ref": "#/171"
+ "$ref": "#/173"
},
"flags": 1,
"description": "Sql always encrypted AKV authentication type. Type: string."
@@ -2957,13 +3070,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/168"
+ "$ref": "#/170"
},
{
- "$ref": "#/169"
+ "$ref": "#/171"
},
{
- "$ref": "#/170"
+ "$ref": "#/172"
},
{
"$ref": "#/2"
@@ -2980,14 +3093,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/174"
+ "$ref": "#/176"
},
"flags": 1,
"description": "Amazon Redshift linked service properties."
},
"type": {
"type": {
- "$ref": "#/175"
+ "$ref": "#/177"
},
"flags": 1,
"description": "Type of linked service."
@@ -3052,14 +3165,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/177"
+ "$ref": "#/179"
},
"flags": 1,
"description": "Amazon S3 linked service properties."
},
"type": {
"type": {
- "$ref": "#/178"
+ "$ref": "#/180"
},
"flags": 1,
"description": "Type of linked service."
@@ -3124,14 +3237,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/180"
+ "$ref": "#/182"
},
"flags": 1,
"description": "Amazon S3 Compatible linked service properties."
},
"type": {
"type": {
- "$ref": "#/181"
+ "$ref": "#/183"
},
"flags": 1,
"description": "Type of linked service."
@@ -3189,14 +3302,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/183"
+ "$ref": "#/185"
},
"flags": 1,
"description": "AppFigures linked service properties."
},
"type": {
"type": {
- "$ref": "#/184"
+ "$ref": "#/186"
},
"flags": 1,
"description": "Type of linked service."
@@ -3240,14 +3353,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/186"
+ "$ref": "#/188"
},
"flags": 1,
"description": "Asana linked service properties."
},
"type": {
"type": {
- "$ref": "#/187"
+ "$ref": "#/189"
},
"flags": 1,
"description": "Type of linked service."
@@ -3284,14 +3397,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/189"
+ "$ref": "#/191"
},
"flags": 1,
"description": "Azure Batch linked service properties."
},
"type": {
"type": {
- "$ref": "#/190"
+ "$ref": "#/192"
},
"flags": 1,
"description": "Type of linked service."
@@ -3363,14 +3476,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/192"
+ "$ref": "#/194"
},
"flags": 1,
"description": "Azure Data Lake Storage Gen2 linked service properties."
},
"type": {
"type": {
- "$ref": "#/193"
+ "$ref": "#/195"
},
"flags": 1,
"description": "Type of linked service."
@@ -3477,14 +3590,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/195"
+ "$ref": "#/197"
},
"flags": 1,
"description": "Azure Blob Storage linked service properties."
},
"type": {
"type": {
- "$ref": "#/203"
+ "$ref": "#/205"
},
"flags": 1,
"description": "Type of linked service."
@@ -3504,7 +3617,7 @@
},
"accountKey": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of accountKey in connection string."
@@ -3518,7 +3631,7 @@
},
"sasToken": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of sasToken in sas uri."
@@ -3581,7 +3694,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/202"
+ "$ref": "#/204"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -3653,19 +3766,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/197"
+ "$ref": "#/199"
},
{
- "$ref": "#/198"
+ "$ref": "#/200"
},
{
- "$ref": "#/199"
+ "$ref": "#/201"
},
{
- "$ref": "#/200"
+ "$ref": "#/202"
},
{
- "$ref": "#/201"
+ "$ref": "#/203"
},
{
"$ref": "#/2"
@@ -3682,14 +3795,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/205"
+ "$ref": "#/207"
},
"flags": 1,
"description": "Azure Data Explorer (Kusto) linked service properties."
},
"type": {
"type": {
- "$ref": "#/206"
+ "$ref": "#/208"
},
"flags": 1,
"description": "Type of linked service."
@@ -3754,14 +3867,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/208"
+ "$ref": "#/210"
},
"flags": 1,
"description": "Azure Data Lake Analytics linked service properties."
},
"type": {
"type": {
- "$ref": "#/209"
+ "$ref": "#/211"
},
"flags": 1,
"description": "Type of linked service."
@@ -3840,14 +3953,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/211"
+ "$ref": "#/213"
},
"flags": 1,
"description": "Azure Data Lake Store linked service properties."
},
"type": {
"type": {
- "$ref": "#/212"
+ "$ref": "#/214"
},
"flags": 1,
"description": "Type of linked service."
@@ -3940,14 +4053,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/214"
+ "$ref": "#/216"
},
"flags": 1,
"description": "Azure Databricks linked service properties."
},
"type": {
"type": {
- "$ref": "#/218"
+ "$ref": "#/220"
},
"flags": 1,
"description": "Type of linked service."
@@ -4023,21 +4136,21 @@
},
"newClusterSparkConf": {
"type": {
- "$ref": "#/215"
+ "$ref": "#/217"
},
"flags": 0,
"description": "A set of optional, user-specified Spark configuration key-value pairs."
},
"newClusterSparkEnvVars": {
"type": {
- "$ref": "#/216"
+ "$ref": "#/218"
},
"flags": 0,
"description": "A set of optional, user-specified Spark environment variables key-value pairs."
},
"newClusterCustomTags": {
"type": {
- "$ref": "#/217"
+ "$ref": "#/219"
},
"flags": 0,
"description": "Additional tags for cluster resources. This property is ignored in instance pool configurations."
@@ -4090,6 +4203,13 @@
},
"flags": 0,
"description": "The credential reference containing authentication information."
+ },
+ "dataSecurityMode": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "The data security mode for the Databricks Cluster. Type: string (or Expression with resultType string)."
}
}
},
@@ -4127,14 +4247,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/220"
+ "$ref": "#/222"
},
"flags": 1,
"description": "Azure Databricks Delta Lake linked service properties."
},
"type": {
"type": {
- "$ref": "#/221"
+ "$ref": "#/223"
},
"flags": 1,
"description": "Type of linked service."
@@ -4199,14 +4319,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/223"
+ "$ref": "#/225"
},
"flags": 1,
"description": "Azure File Storage linked service properties."
},
"type": {
"type": {
- "$ref": "#/224"
+ "$ref": "#/226"
},
"flags": 1,
"description": "Type of linked service."
@@ -4247,7 +4367,7 @@
},
"accountKey": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of accountKey in connection string."
@@ -4261,7 +4381,7 @@
},
"sasToken": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of sasToken in sas uri."
@@ -4313,14 +4433,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/226"
+ "$ref": "#/228"
},
"flags": 1,
"description": "Azure Function linked service properties."
},
"type": {
"type": {
- "$ref": "#/227"
+ "$ref": "#/229"
},
"flags": 1,
"description": "Type of linked service."
@@ -4385,14 +4505,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/229"
+ "$ref": "#/231"
},
"flags": 1,
"description": "Azure Key Vault linked service properties."
},
"type": {
"type": {
- "$ref": "#/230"
+ "$ref": "#/232"
},
"flags": 1,
"description": "Type of linked service."
@@ -4429,14 +4549,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/232"
+ "$ref": "#/234"
},
"flags": 1,
"description": "Azure ML Studio Web Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/233"
+ "$ref": "#/235"
},
"flags": 1,
"description": "Type of linked service."
@@ -4515,14 +4635,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/235"
+ "$ref": "#/237"
},
"flags": 1,
"description": "Azure ML Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/236"
+ "$ref": "#/238"
},
"flags": 1,
"description": "Type of linked service."
@@ -4601,14 +4721,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/238"
+ "$ref": "#/240"
},
"flags": 1,
"description": "Azure Database for MariaDB linked service properties."
},
"type": {
"type": {
- "$ref": "#/239"
+ "$ref": "#/241"
},
"flags": 1,
"description": "Type of linked service."
@@ -4628,7 +4748,7 @@
},
"pwd": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -4652,14 +4772,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/241"
+ "$ref": "#/243"
},
"flags": 1,
"description": "Azure MySQL database linked service properties."
},
"type": {
"type": {
- "$ref": "#/242"
+ "$ref": "#/244"
},
"flags": 1,
"description": "Type of linked service."
@@ -4679,7 +4799,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -4703,14 +4823,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/244"
+ "$ref": "#/246"
},
"flags": 1,
"description": "Azure PostgreSQL linked service properties."
},
"type": {
"type": {
- "$ref": "#/245"
+ "$ref": "#/247"
},
"flags": 1,
"description": "Type of linked service."
@@ -4807,7 +4927,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -4887,14 +5007,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/247"
+ "$ref": "#/249"
},
"flags": 1,
"description": "Windows Azure Search Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/248"
+ "$ref": "#/250"
},
"flags": 1,
"description": "Type of linked service."
@@ -4938,14 +5058,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/250"
+ "$ref": "#/252"
},
"flags": 1,
"description": "Azure SQL Data Warehouse linked service properties."
},
"type": {
"type": {
- "$ref": "#/256"
+ "$ref": "#/258"
},
"flags": 1,
"description": "Type of linked service."
@@ -4965,7 +5085,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/255"
+ "$ref": "#/257"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -4979,7 +5099,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -5195,16 +5315,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/251"
+ "$ref": "#/253"
},
{
- "$ref": "#/252"
+ "$ref": "#/254"
},
{
- "$ref": "#/253"
+ "$ref": "#/255"
},
{
- "$ref": "#/254"
+ "$ref": "#/256"
},
{
"$ref": "#/2"
@@ -5221,14 +5341,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/258"
+ "$ref": "#/260"
},
"flags": 1,
"description": "Azure SQL Database linked service properties."
},
"type": {
"type": {
- "$ref": "#/264"
+ "$ref": "#/266"
},
"flags": 1,
"description": "Type of linked service."
@@ -5248,7 +5368,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/263"
+ "$ref": "#/265"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -5262,7 +5382,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -5318,7 +5438,7 @@
},
"alwaysEncryptedSettings": {
"type": {
- "$ref": "#/167"
+ "$ref": "#/169"
},
"flags": 0,
"description": "Sql always encrypted properties."
@@ -5485,16 +5605,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/259"
+ "$ref": "#/261"
},
{
- "$ref": "#/260"
+ "$ref": "#/262"
},
{
- "$ref": "#/261"
+ "$ref": "#/263"
},
{
- "$ref": "#/262"
+ "$ref": "#/264"
},
{
"$ref": "#/2"
@@ -5511,14 +5631,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/266"
+ "$ref": "#/268"
},
"flags": 1,
"description": "Azure SQL Managed Instance linked service properties."
},
"type": {
"type": {
- "$ref": "#/272"
+ "$ref": "#/274"
},
"flags": 1,
"description": "Type of linked service."
@@ -5538,7 +5658,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/271"
+ "$ref": "#/273"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -5552,7 +5672,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -5608,7 +5728,7 @@
},
"alwaysEncryptedSettings": {
"type": {
- "$ref": "#/167"
+ "$ref": "#/169"
},
"flags": 0,
"description": "Sql always encrypted properties."
@@ -5775,16 +5895,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/267"
+ "$ref": "#/269"
},
{
- "$ref": "#/268"
+ "$ref": "#/270"
},
{
- "$ref": "#/269"
+ "$ref": "#/271"
},
{
- "$ref": "#/270"
+ "$ref": "#/272"
},
{
"$ref": "#/2"
@@ -5801,14 +5921,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/274"
+ "$ref": "#/276"
},
"flags": 1,
"description": "Azure Storage linked service properties."
},
"type": {
"type": {
- "$ref": "#/275"
+ "$ref": "#/277"
},
"flags": 1,
"description": "Type of linked service."
@@ -5828,7 +5948,7 @@
},
"accountKey": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of accountKey in connection string."
@@ -5842,7 +5962,7 @@
},
"sasToken": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of sasToken in sas uri."
@@ -5866,14 +5986,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/277"
+ "$ref": "#/279"
},
"flags": 1,
"description": "Azure Synapse Analytics (Artifacts) linked service properties."
},
"type": {
"type": {
- "$ref": "#/278"
+ "$ref": "#/280"
},
"flags": 1,
"description": "Type of linked service."
@@ -5917,14 +6037,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/280"
+ "$ref": "#/282"
},
"flags": 1,
"description": "Azure Table Storage linked service properties."
},
"type": {
"type": {
- "$ref": "#/281"
+ "$ref": "#/283"
},
"flags": 1,
"description": "Type of linked service."
@@ -5958,7 +6078,7 @@
},
"accountKey": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of accountKey in connection string."
@@ -5972,7 +6092,7 @@
},
"sasToken": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of sasToken in sas uri."
@@ -5996,14 +6116,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/283"
+ "$ref": "#/285"
},
"flags": 1,
"description": "Cassandra linked service properties."
},
"type": {
"type": {
- "$ref": "#/284"
+ "$ref": "#/286"
},
"flags": 1,
"description": "Type of linked service."
@@ -6068,14 +6188,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/286"
+ "$ref": "#/288"
},
"flags": 1,
"description": "Common Data Service for Apps linked service properties."
},
"type": {
"type": {
- "$ref": "#/287"
+ "$ref": "#/289"
},
"flags": 1,
"description": "Type of linked service."
@@ -6189,14 +6309,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/289"
+ "$ref": "#/291"
},
"flags": 1,
"description": "Concur Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/290"
+ "$ref": "#/292"
},
"flags": 1,
"description": "Type of linked service."
@@ -6275,14 +6395,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/292"
+ "$ref": "#/294"
},
"flags": 1,
"description": "CosmosDB linked service properties."
},
"type": {
"type": {
- "$ref": "#/296"
+ "$ref": "#/298"
},
"flags": 1,
"description": "Type of linked service."
@@ -6358,7 +6478,7 @@
},
"connectionMode": {
"type": {
- "$ref": "#/295"
+ "$ref": "#/297"
},
"flags": 0,
"description": "The connection mode used to access CosmosDB account. Type: string."
@@ -6391,10 +6511,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/293"
+ "$ref": "#/295"
},
{
- "$ref": "#/294"
+ "$ref": "#/296"
},
{
"$ref": "#/2"
@@ -6411,14 +6531,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/298"
+ "$ref": "#/300"
},
"flags": 1,
"description": "CosmosDB (MongoDB API) linked service properties."
},
"type": {
"type": {
- "$ref": "#/299"
+ "$ref": "#/301"
},
"flags": 1,
"description": "Type of linked service."
@@ -6462,14 +6582,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/301"
+ "$ref": "#/303"
},
"flags": 1,
"description": "Couchbase server linked service properties."
},
"type": {
"type": {
- "$ref": "#/302"
+ "$ref": "#/304"
},
"flags": 1,
"description": "Type of linked service."
@@ -6489,7 +6609,7 @@
},
"credString": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of credString in connection string."
@@ -6520,7 +6640,7 @@
},
"type": {
"type": {
- "$ref": "#/304"
+ "$ref": "#/306"
},
"flags": 1,
"description": "Type of linked service."
@@ -6537,14 +6657,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/306"
+ "$ref": "#/308"
},
"flags": 1,
"description": "Dataworld linked service properties."
},
"type": {
"type": {
- "$ref": "#/307"
+ "$ref": "#/309"
},
"flags": 1,
"description": "Type of linked service."
@@ -6581,14 +6701,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/309"
+ "$ref": "#/311"
},
"flags": 1,
"description": "DB2 linked service properties."
},
"type": {
"type": {
- "$ref": "#/312"
+ "$ref": "#/314"
},
"flags": 1,
"description": "Type of linked service."
@@ -6622,7 +6742,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/311"
+ "$ref": "#/313"
},
"flags": 0,
"description": "AuthenticationType to be used for connection. It is mutually exclusive with connectionString property."
@@ -6672,7 +6792,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/310"
+ "$ref": "#/312"
},
{
"$ref": "#/2"
@@ -6689,14 +6809,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/314"
+ "$ref": "#/316"
},
"flags": 1,
"description": "Drill server linked service properties."
},
"type": {
"type": {
- "$ref": "#/315"
+ "$ref": "#/317"
},
"flags": 1,
"description": "Type of linked service."
@@ -6716,7 +6836,7 @@
},
"pwd": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -6740,14 +6860,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/317"
+ "$ref": "#/319"
},
"flags": 1,
"description": "Dynamics linked service properties."
},
"type": {
"type": {
- "$ref": "#/318"
+ "$ref": "#/320"
},
"flags": 1,
"description": "Type of linked service."
@@ -6868,14 +6988,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/320"
+ "$ref": "#/322"
},
"flags": 1,
"description": "Dynamics AX linked service properties."
},
"type": {
"type": {
- "$ref": "#/321"
+ "$ref": "#/323"
},
"flags": 1,
"description": "Type of linked service."
@@ -6940,14 +7060,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/323"
+ "$ref": "#/325"
},
"flags": 1,
"description": "Dynamics CRM linked service properties."
},
"type": {
"type": {
- "$ref": "#/324"
+ "$ref": "#/326"
},
"flags": 1,
"description": "Type of linked service."
@@ -7068,14 +7188,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/326"
+ "$ref": "#/328"
},
"flags": 1,
"description": "Eloqua server linked service properties."
},
"type": {
"type": {
- "$ref": "#/327"
+ "$ref": "#/329"
},
"flags": 1,
"description": "Type of linked service."
@@ -7147,14 +7267,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/329"
+ "$ref": "#/331"
},
"flags": 1,
"description": "File system linked service properties."
},
"type": {
"type": {
- "$ref": "#/330"
+ "$ref": "#/332"
},
"flags": 1,
"description": "Type of linked service."
@@ -7205,14 +7325,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/332"
+ "$ref": "#/334"
},
"flags": 1,
"description": "Properties specific to this linked service type."
},
"type": {
"type": {
- "$ref": "#/336"
+ "$ref": "#/338"
},
"flags": 1,
"description": "Type of linked service."
@@ -7239,7 +7359,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/335"
+ "$ref": "#/337"
},
"flags": 0,
"description": "The authentication type to be used to connect to the FTP server."
@@ -7293,10 +7413,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/333"
+ "$ref": "#/335"
},
{
- "$ref": "#/334"
+ "$ref": "#/336"
},
{
"$ref": "#/2"
@@ -7313,14 +7433,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/338"
+ "$ref": "#/340"
},
"flags": 1,
"description": "Google AdWords service linked service properties."
},
"type": {
"type": {
- "$ref": "#/342"
+ "$ref": "#/344"
},
"flags": 1,
"description": "Type of linked service."
@@ -7354,7 +7474,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/341"
+ "$ref": "#/343"
},
"flags": 0,
"description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR."
@@ -7457,10 +7577,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/339"
+ "$ref": "#/341"
},
{
- "$ref": "#/340"
+ "$ref": "#/342"
},
{
"$ref": "#/2"
@@ -7477,14 +7597,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/344"
+ "$ref": "#/346"
},
"flags": 1,
"description": "Google BigQuery service linked service properties."
},
"type": {
"type": {
- "$ref": "#/348"
+ "$ref": "#/350"
},
"flags": 1,
"description": "Type of linked service."
@@ -7518,7 +7638,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/347"
+ "$ref": "#/349"
},
"flags": 1,
"description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR."
@@ -7593,10 +7713,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/345"
+ "$ref": "#/347"
},
{
- "$ref": "#/346"
+ "$ref": "#/348"
},
{
"$ref": "#/2"
@@ -7613,14 +7733,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/350"
+ "$ref": "#/352"
},
"flags": 1,
"description": "Google BigQuery service linked service properties."
},
"type": {
"type": {
- "$ref": "#/354"
+ "$ref": "#/356"
},
"flags": 1,
"description": "Type of linked service."
@@ -7640,7 +7760,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/353"
+ "$ref": "#/355"
},
"flags": 1,
"description": "The OAuth 2.0 authentication mechanism used for authentication."
@@ -7694,10 +7814,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/351"
+ "$ref": "#/353"
},
{
- "$ref": "#/352"
+ "$ref": "#/354"
},
{
"$ref": "#/2"
@@ -7714,14 +7834,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/356"
+ "$ref": "#/358"
},
"flags": 1,
"description": "Google Cloud Storage linked service properties."
},
"type": {
"type": {
- "$ref": "#/357"
+ "$ref": "#/359"
},
"flags": 1,
"description": "Type of linked service."
@@ -7772,14 +7892,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/359"
+ "$ref": "#/361"
},
"flags": 1,
"description": "GoogleSheets linked service properties."
},
"type": {
"type": {
- "$ref": "#/360"
+ "$ref": "#/362"
},
"flags": 1,
"description": "Type of linked service."
@@ -7816,14 +7936,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/362"
+ "$ref": "#/364"
},
"flags": 1,
"description": "Greenplum Database linked service properties."
},
"type": {
"type": {
- "$ref": "#/365"
+ "$ref": "#/367"
},
"flags": 1,
"description": "Type of linked service."
@@ -7843,7 +7963,7 @@
},
"pwd": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -7857,7 +7977,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/364"
+ "$ref": "#/366"
},
"flags": 0,
"description": "The authentication type to use. Type: string. Only used for V2."
@@ -7910,13 +8030,6 @@
},
"flags": 0,
"description": "The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer. Only used for V2."
- },
- "password": {
- "type": {
- "$ref": "#/100"
- },
- "flags": 0,
- "description": "The Azure key vault secret reference of password in connection string. Type: string. Only used for V2."
}
}
},
@@ -7928,7 +8041,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/363"
+ "$ref": "#/365"
},
{
"$ref": "#/2"
@@ -7945,14 +8058,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/367"
+ "$ref": "#/369"
},
"flags": 1,
"description": "HBase server linked service properties."
},
"type": {
"type": {
- "$ref": "#/371"
+ "$ref": "#/373"
},
"flags": 1,
"description": "Type of linked service."
@@ -7986,7 +8099,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/370"
+ "$ref": "#/372"
},
"flags": 1,
"description": "The authentication mechanism to use to connect to the HBase server."
@@ -8054,10 +8167,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/368"
+ "$ref": "#/370"
},
{
- "$ref": "#/369"
+ "$ref": "#/371"
},
{
"$ref": "#/2"
@@ -8074,14 +8187,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/373"
+ "$ref": "#/375"
},
"flags": 1,
"description": "HDInsight linked service properties."
},
"type": {
"type": {
- "$ref": "#/374"
+ "$ref": "#/376"
},
"flags": 1,
"description": "Type of linked service."
@@ -8160,14 +8273,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/376"
+ "$ref": "#/378"
},
"flags": 1,
"description": "HDInsight ondemand linked service properties."
},
"type": {
"type": {
- "$ref": "#/380"
+ "$ref": "#/382"
},
"flags": 1,
"description": "Type of linked service."
@@ -8278,7 +8391,7 @@
},
"additionalLinkedServiceNames": {
"type": {
- "$ref": "#/377"
+ "$ref": "#/379"
},
"flags": 0,
"description": "Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf."
@@ -8390,7 +8503,7 @@
},
"scriptActions": {
"type": {
- "$ref": "#/379"
+ "$ref": "#/381"
},
"flags": 0,
"description": "Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions."
@@ -8461,7 +8574,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/378"
+ "$ref": "#/380"
}
},
{
@@ -8474,14 +8587,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/382"
+ "$ref": "#/384"
},
"flags": 1,
"description": "HDFS linked service properties."
},
"type": {
"type": {
- "$ref": "#/383"
+ "$ref": "#/385"
},
"flags": 1,
"description": "Type of linked service."
@@ -8539,14 +8652,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/385"
+ "$ref": "#/387"
},
"flags": 1,
"description": "Hive Server linked service properties."
},
"type": {
"type": {
- "$ref": "#/399"
+ "$ref": "#/401"
},
"flags": 1,
"description": "Type of linked service."
@@ -8573,21 +8686,21 @@
},
"serverType": {
"type": {
- "$ref": "#/389"
+ "$ref": "#/391"
},
"flags": 0,
"description": "The type of Hive server."
},
"thriftTransportProtocol": {
"type": {
- "$ref": "#/393"
+ "$ref": "#/395"
},
"flags": 0,
"description": "The transport protocol to use in the Thrift layer."
},
"authenticationType": {
"type": {
- "$ref": "#/398"
+ "$ref": "#/400"
},
"flags": 1,
"description": "The authentication method used to access the Hive server."
@@ -8694,13 +8807,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/386"
+ "$ref": "#/388"
},
{
- "$ref": "#/387"
+ "$ref": "#/389"
},
{
- "$ref": "#/388"
+ "$ref": "#/390"
},
{
"$ref": "#/2"
@@ -8723,13 +8836,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/390"
+ "$ref": "#/392"
},
{
- "$ref": "#/391"
+ "$ref": "#/393"
},
{
- "$ref": "#/392"
+ "$ref": "#/394"
},
{
"$ref": "#/2"
@@ -8756,16 +8869,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/394"
+ "$ref": "#/396"
},
{
- "$ref": "#/395"
+ "$ref": "#/397"
},
{
- "$ref": "#/396"
+ "$ref": "#/398"
},
{
- "$ref": "#/397"
+ "$ref": "#/399"
},
{
"$ref": "#/2"
@@ -8782,14 +8895,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/401"
+ "$ref": "#/403"
},
"flags": 1,
"description": "Properties specific to this linked service type."
},
"type": {
"type": {
- "$ref": "#/408"
+ "$ref": "#/410"
},
"flags": 1,
"description": "Type of linked service."
@@ -8809,7 +8922,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/407"
+ "$ref": "#/409"
},
"flags": 0,
"description": "The authentication type to be used to connect to the HTTP server."
@@ -8889,19 +9002,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/402"
+ "$ref": "#/404"
},
{
- "$ref": "#/403"
+ "$ref": "#/405"
},
{
- "$ref": "#/404"
+ "$ref": "#/406"
},
{
- "$ref": "#/405"
+ "$ref": "#/407"
},
{
- "$ref": "#/406"
+ "$ref": "#/408"
},
{
"$ref": "#/2"
@@ -8918,14 +9031,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/410"
+ "$ref": "#/412"
},
"flags": 1,
"description": "Hubspot Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/411"
+ "$ref": "#/413"
},
"flags": 1,
"description": "Type of linked service."
@@ -9004,14 +9117,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/413"
+ "$ref": "#/415"
},
"flags": 1,
"description": "Impala server linked service properties."
},
"type": {
"type": {
- "$ref": "#/418"
+ "$ref": "#/423"
},
"flags": 1,
"description": "Type of linked service."
@@ -9038,7 +9151,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/417"
+ "$ref": "#/419"
},
"flags": 1,
"description": "The authentication type to use."
@@ -9057,6 +9170,13 @@
"flags": 0,
"description": "The password corresponding to the user name when using UsernameAndPassword."
},
+ "thriftTransportProtocol": {
+ "type": {
+ "$ref": "#/422"
+ },
+ "flags": 0,
+ "description": "The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary."
+ },
"enableSsl": {
"type": {
"$ref": "#/11"
@@ -9064,6 +9184,13 @@
"flags": 0,
"description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false."
},
+ "enableServerCertificateValidation": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specify whether to enable server SSL certificate validation when you connect.Always use System Trust Store (for V2 only). The default value is true."
+ },
"trustedCertPath": {
"type": {
"$ref": "#/11"
@@ -9117,19 +9244,38 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/414"
+ "$ref": "#/416"
},
{
- "$ref": "#/415"
+ "$ref": "#/417"
},
{
- "$ref": "#/416"
+ "$ref": "#/418"
},
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "StringLiteralType",
+ "value": "Binary"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "HTTP"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/420"
+ },
+ {
+ "$ref": "#/421"
+ }
+ ]
+ },
{
"$type": "StringLiteralType",
"value": "Impala"
@@ -9140,14 +9286,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/420"
+ "$ref": "#/425"
},
"flags": 1,
"description": "Informix linked service properties."
},
"type": {
"type": {
- "$ref": "#/421"
+ "$ref": "#/426"
},
"flags": 1,
"description": "Type of linked service."
@@ -9212,14 +9358,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/423"
+ "$ref": "#/428"
},
"flags": 1,
"description": "Jira Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/424"
+ "$ref": "#/429"
},
"flags": 1,
"description": "Type of linked service."
@@ -9298,14 +9444,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/426"
+ "$ref": "#/431"
},
"flags": 1,
"description": "Microsoft Fabric Lakehouse linked service properties."
},
"type": {
"type": {
- "$ref": "#/427"
+ "$ref": "#/432"
},
"flags": 1,
"description": "Type of linked service."
@@ -9384,14 +9530,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/429"
+ "$ref": "#/434"
},
"flags": 1,
"description": "Magento server linked service properties."
},
"type": {
"type": {
- "$ref": "#/430"
+ "$ref": "#/435"
},
"flags": 1,
"description": "Type of linked service."
@@ -9456,14 +9602,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/432"
+ "$ref": "#/437"
},
"flags": 1,
"description": "MariaDB server linked service properties."
},
"type": {
"type": {
- "$ref": "#/433"
+ "$ref": "#/438"
},
"flags": 1,
"description": "Type of linked service."
@@ -9532,7 +9678,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -9556,14 +9702,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/435"
+ "$ref": "#/440"
},
"flags": 1,
"description": "Marketo server linked service properties."
},
"type": {
"type": {
- "$ref": "#/436"
+ "$ref": "#/441"
},
"flags": 1,
"description": "Type of linked service."
@@ -9635,14 +9781,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/438"
+ "$ref": "#/443"
},
"flags": 1,
"description": "Microsoft Access linked service properties."
},
"type": {
"type": {
- "$ref": "#/439"
+ "$ref": "#/444"
},
"flags": 1,
"description": "Type of linked service."
@@ -9707,14 +9853,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/441"
+ "$ref": "#/446"
},
"flags": 1,
"description": "MongoDB linked service properties."
},
"type": {
"type": {
- "$ref": "#/445"
+ "$ref": "#/450"
},
"flags": 1,
"description": "Type of linked service."
@@ -9734,7 +9880,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/444"
+ "$ref": "#/449"
},
"flags": 0,
"description": "The authentication type to be used to connect to the MongoDB database."
@@ -9809,10 +9955,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/442"
+ "$ref": "#/447"
},
{
- "$ref": "#/443"
+ "$ref": "#/448"
},
{
"$ref": "#/2"
@@ -9829,14 +9975,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/447"
+ "$ref": "#/452"
},
"flags": 1,
"description": "MongoDB Atlas linked service properties."
},
"type": {
"type": {
- "$ref": "#/448"
+ "$ref": "#/453"
},
"flags": 1,
"description": "Type of linked service."
@@ -9880,14 +10026,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/450"
+ "$ref": "#/455"
},
"flags": 1,
"description": "MongoDB linked service properties."
},
"type": {
"type": {
- "$ref": "#/451"
+ "$ref": "#/456"
},
"flags": 1,
"description": "Type of linked service."
@@ -9924,14 +10070,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/453"
+ "$ref": "#/458"
},
"flags": 1,
"description": "MySQL linked service properties."
},
"type": {
"type": {
- "$ref": "#/454"
+ "$ref": "#/459"
},
"flags": 1,
"description": "Type of linked service."
@@ -10000,7 +10146,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -10073,14 +10219,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/456"
+ "$ref": "#/461"
},
"flags": 1,
"description": "Netezza linked service properties."
},
"type": {
"type": {
- "$ref": "#/457"
+ "$ref": "#/462"
},
"flags": 1,
"description": "Type of linked service."
@@ -10100,7 +10246,7 @@
},
"pwd": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -10124,14 +10270,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/459"
+ "$ref": "#/464"
},
"flags": 1,
"description": "OData linked service properties."
},
"type": {
"type": {
- "$ref": "#/469"
+ "$ref": "#/474"
},
"flags": 1,
"description": "Type of linked service."
@@ -10151,7 +10297,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/465"
+ "$ref": "#/470"
},
"flags": 0,
"description": "Type of authentication used to connect to the OData service."
@@ -10207,7 +10353,7 @@
},
"aadServicePrincipalCredentialType": {
"type": {
- "$ref": "#/468"
+ "$ref": "#/473"
},
"flags": 0,
"description": "Specify the credential type (key or cert) is used for service principal."
@@ -10266,19 +10412,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/460"
+ "$ref": "#/465"
},
{
- "$ref": "#/461"
+ "$ref": "#/466"
},
{
- "$ref": "#/462"
+ "$ref": "#/467"
},
{
- "$ref": "#/463"
+ "$ref": "#/468"
},
{
- "$ref": "#/464"
+ "$ref": "#/469"
},
{
"$ref": "#/2"
@@ -10297,10 +10443,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/466"
+ "$ref": "#/471"
},
{
- "$ref": "#/467"
+ "$ref": "#/472"
},
{
"$ref": "#/2"
@@ -10317,14 +10463,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/471"
+ "$ref": "#/476"
},
"flags": 1,
"description": "ODBC linked service properties."
},
"type": {
"type": {
- "$ref": "#/472"
+ "$ref": "#/477"
},
"flags": 1,
"description": "Type of linked service."
@@ -10389,14 +10535,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/474"
+ "$ref": "#/479"
},
"flags": 1,
"description": "Office365 linked service properties."
},
"type": {
"type": {
- "$ref": "#/475"
+ "$ref": "#/480"
},
"flags": 1,
"description": "Type of linked service."
@@ -10435,6 +10581,27 @@
"flags": 1,
"description": "Specify the application's key."
},
+ "servicePrincipalCredentialType": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "The service principal credential type for authentication.'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. If not specified, 'ServicePrincipalKey' is in use. Type: string (or Expression with resultType string)."
+ },
+ "servicePrincipalEmbeddedCert": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)."
+ },
+ "servicePrincipalEmbeddedCertPassword": {
+ "type": {
+ "$ref": "#/100"
+ },
+ "flags": 0,
+ "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string)."
+ },
"encryptedCredential": {
"type": {
"$ref": "#/2"
@@ -10454,14 +10621,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/477"
+ "$ref": "#/482"
},
"flags": 1,
"description": "Oracle database linked service properties."
},
"type": {
"type": {
- "$ref": "#/480"
+ "$ref": "#/485"
},
"flags": 1,
"description": "Type of linked service."
@@ -10488,7 +10655,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/479"
+ "$ref": "#/484"
},
"flags": 0,
"description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0."
@@ -10502,7 +10669,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -10601,7 +10768,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/478"
+ "$ref": "#/483"
},
{
"$ref": "#/2"
@@ -10618,14 +10785,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/482"
+ "$ref": "#/487"
},
"flags": 1,
"description": "Oracle Cloud Storage linked service properties."
},
"type": {
"type": {
- "$ref": "#/483"
+ "$ref": "#/488"
},
"flags": 1,
"description": "Type of linked service."
@@ -10676,14 +10843,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/485"
+ "$ref": "#/490"
},
"flags": 1,
"description": "Oracle Service Cloud linked service properties."
},
"type": {
"type": {
- "$ref": "#/486"
+ "$ref": "#/491"
},
"flags": 1,
"description": "Type of linked service."
@@ -10755,14 +10922,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/488"
+ "$ref": "#/493"
},
"flags": 1,
"description": "Paypal Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/489"
+ "$ref": "#/494"
},
"flags": 1,
"description": "Type of linked service."
@@ -10834,14 +11001,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/491"
+ "$ref": "#/496"
},
"flags": 1,
"description": "Phoenix server linked service properties."
},
"type": {
"type": {
- "$ref": "#/496"
+ "$ref": "#/501"
},
"flags": 1,
"description": "Type of linked service."
@@ -10875,7 +11042,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/495"
+ "$ref": "#/500"
},
"flags": 1,
"description": "The authentication mechanism used to connect to the Phoenix server."
@@ -10954,13 +11121,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/492"
+ "$ref": "#/497"
},
{
- "$ref": "#/493"
+ "$ref": "#/498"
},
{
- "$ref": "#/494"
+ "$ref": "#/499"
},
{
"$ref": "#/2"
@@ -10977,14 +11144,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/498"
+ "$ref": "#/503"
},
"flags": 1,
"description": "PostgreSQL linked service properties."
},
"type": {
"type": {
- "$ref": "#/499"
+ "$ref": "#/504"
},
"flags": 1,
"description": "Type of linked service."
@@ -11004,7 +11171,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -11028,14 +11195,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/501"
+ "$ref": "#/506"
},
"flags": 1,
"description": "PostgreSQLV2 linked service properties."
},
"type": {
"type": {
- "$ref": "#/502"
+ "$ref": "#/507"
},
"flags": 1,
"description": "Type of linked service."
@@ -11174,7 +11341,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string. Type: string."
@@ -11198,14 +11365,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/504"
+ "$ref": "#/509"
},
"flags": 1,
"description": "Presto server linked service properties."
},
"type": {
"type": {
- "$ref": "#/508"
+ "$ref": "#/513"
},
"flags": 1,
"description": "Type of linked service."
@@ -11227,8 +11394,8 @@
"type": {
"$ref": "#/11"
},
- "flags": 1,
- "description": "The version of the Presto server. (i.e. 0.148-t)"
+ "flags": 0,
+ "description": "The version of the Presto server. (i.e. 0.148-t) Only used for Version 1.0."
},
"catalog": {
"type": {
@@ -11242,11 +11409,11 @@
"$ref": "#/11"
},
"flags": 0,
- "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080."
+ "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080 when disable SSL, default value is 443 when enable SSL."
},
"authenticationType": {
"type": {
- "$ref": "#/507"
+ "$ref": "#/512"
},
"flags": 1,
"description": "The authentication mechanism used to connect to the Presto server."
@@ -11270,42 +11437,49 @@
"$ref": "#/11"
},
"flags": 0,
- "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false."
+ "description": "Specifies whether the connections to the server are encrypted using SSL. The default value for legacy version is False. The default value for version 2.0 is True."
+ },
+ "enableServerCertificateValidation": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0"
},
"trustedCertPath": {
"type": {
"$ref": "#/11"
},
"flags": 0,
- "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR."
+ "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Only used for Version 1.0."
},
"useSystemTrustStore": {
"type": {
"$ref": "#/11"
},
"flags": 0,
- "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false."
+ "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Only used for Version 1.0."
},
"allowHostNameCNMismatch": {
"type": {
"$ref": "#/11"
},
"flags": 0,
- "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false."
+ "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. Only used for Version 1.0."
},
"allowSelfSignedServerCert": {
"type": {
"$ref": "#/11"
},
"flags": 0,
- "description": "Specifies whether to allow self-signed certificates from the server. The default value is false."
+ "description": "Specifies whether to allow self-signed certificates from the server. The default value is false. Only used for Version 1.0."
},
"timeZoneID": {
"type": {
"$ref": "#/11"
},
"flags": 0,
- "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone."
+ "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value for Version 1.0 is the client system time zone. The default value for Version 2.0 is server system timeZone"
},
"encryptedCredential": {
"type": {
@@ -11328,10 +11502,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/505"
+ "$ref": "#/510"
},
{
- "$ref": "#/506"
+ "$ref": "#/511"
},
{
"$ref": "#/2"
@@ -11348,14 +11522,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/510"
+ "$ref": "#/515"
},
"flags": 1,
"description": "QuickBooks server linked service properties."
},
"type": {
"type": {
- "$ref": "#/511"
+ "$ref": "#/516"
},
"flags": 1,
"description": "Type of linked service."
@@ -11441,14 +11615,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/513"
+ "$ref": "#/518"
},
"flags": 1,
"description": "Quickbase linked service properties."
},
"type": {
"type": {
- "$ref": "#/514"
+ "$ref": "#/519"
},
"flags": 1,
"description": "Type of linked service."
@@ -11492,14 +11666,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/516"
+ "$ref": "#/521"
},
"flags": 1,
"description": "Responsys linked service properties."
},
"type": {
"type": {
- "$ref": "#/517"
+ "$ref": "#/522"
},
"flags": 1,
"description": "Type of linked service."
@@ -11571,14 +11745,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/519"
+ "$ref": "#/524"
},
"flags": 1,
"description": "Rest Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/526"
+ "$ref": "#/531"
},
"flags": 1,
"description": "Type of linked service."
@@ -11605,7 +11779,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/525"
+ "$ref": "#/530"
},
"flags": 1,
"description": "Type of authentication used to connect to the REST service."
@@ -11762,19 +11936,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/520"
+ "$ref": "#/525"
},
{
- "$ref": "#/521"
+ "$ref": "#/526"
},
{
- "$ref": "#/522"
+ "$ref": "#/527"
},
{
- "$ref": "#/523"
+ "$ref": "#/528"
},
{
- "$ref": "#/524"
+ "$ref": "#/529"
},
{
"$ref": "#/2"
@@ -11791,14 +11965,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/528"
+ "$ref": "#/533"
},
"flags": 1,
"description": "Salesforce linked service properties."
},
"type": {
"type": {
- "$ref": "#/529"
+ "$ref": "#/534"
},
"flags": 1,
"description": "Type of linked service."
@@ -11863,14 +12037,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/531"
+ "$ref": "#/536"
},
"flags": 1,
"description": "Salesforce Marketing Cloud linked service properties."
},
"type": {
"type": {
- "$ref": "#/532"
+ "$ref": "#/537"
},
"flags": 1,
"description": "Type of linked service."
@@ -11942,14 +12116,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/534"
+ "$ref": "#/539"
},
"flags": 1,
"description": "Salesforce Service Cloud linked service properties."
},
"type": {
"type": {
- "$ref": "#/535"
+ "$ref": "#/540"
},
"flags": 1,
"description": "Type of linked service."
@@ -12021,14 +12195,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/537"
+ "$ref": "#/542"
},
"flags": 1,
"description": "Salesforce Service Cloud V2 linked service properties."
},
"type": {
"type": {
- "$ref": "#/538"
+ "$ref": "#/543"
},
"flags": 1,
"description": "Type of linked service."
@@ -12093,14 +12267,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/540"
+ "$ref": "#/545"
},
"flags": 1,
"description": "Salesforce V2 linked service properties."
},
"type": {
"type": {
- "$ref": "#/541"
+ "$ref": "#/546"
},
"flags": 1,
"description": "Type of linked service."
@@ -12165,14 +12339,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/543"
+ "$ref": "#/548"
},
"flags": 1,
"description": "Properties specific to this linked service type."
},
"type": {
"type": {
- "$ref": "#/544"
+ "$ref": "#/549"
},
"flags": 1,
"description": "Type of linked service."
@@ -12237,14 +12411,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/546"
+ "$ref": "#/551"
},
"flags": 1,
"description": "SAP Cloud for Customer linked service properties."
},
"type": {
"type": {
- "$ref": "#/547"
+ "$ref": "#/552"
},
"flags": 1,
"description": "Type of linked service."
@@ -12295,14 +12469,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/549"
+ "$ref": "#/554"
},
"flags": 1,
"description": "SAP ECC linked service properties."
},
"type": {
"type": {
- "$ref": "#/550"
+ "$ref": "#/555"
},
"flags": 1,
"description": "Type of linked service."
@@ -12353,14 +12527,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/552"
+ "$ref": "#/557"
},
"flags": 1,
"description": "Properties specific to this linked service type."
},
"type": {
"type": {
- "$ref": "#/556"
+ "$ref": "#/561"
},
"flags": 1,
"description": "Type of linked service."
@@ -12387,7 +12561,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/555"
+ "$ref": "#/560"
},
"flags": 0,
"description": "The authentication type to be used to connect to the SAP HANA server."
@@ -12427,10 +12601,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/553"
+ "$ref": "#/558"
},
{
- "$ref": "#/554"
+ "$ref": "#/559"
},
{
"$ref": "#/2"
@@ -12447,14 +12621,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/558"
+ "$ref": "#/563"
},
"flags": 1,
"description": "Properties specific to SAP ODP linked service type."
},
"type": {
"type": {
- "$ref": "#/559"
+ "$ref": "#/564"
},
"flags": 1,
"description": "Type of linked service."
@@ -12603,14 +12777,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/561"
+ "$ref": "#/566"
},
"flags": 1,
"description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type."
},
"type": {
"type": {
- "$ref": "#/562"
+ "$ref": "#/567"
},
"flags": 1,
"description": "Type of linked service."
@@ -12710,14 +12884,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/564"
+ "$ref": "#/569"
},
"flags": 1,
"description": "Properties specific to this linked service type."
},
"type": {
"type": {
- "$ref": "#/565"
+ "$ref": "#/570"
},
"flags": 1,
"description": "Type of linked service."
@@ -12852,14 +13026,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/567"
+ "$ref": "#/572"
},
"flags": 1,
"description": "ServiceNow server linked service properties."
},
"type": {
"type": {
- "$ref": "#/571"
+ "$ref": "#/576"
},
"flags": 1,
"description": "Type of linked service."
@@ -12879,7 +13053,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/570"
+ "$ref": "#/575"
},
"flags": 1,
"description": "The authentication type to use."
@@ -12954,10 +13128,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/568"
+ "$ref": "#/573"
},
{
- "$ref": "#/569"
+ "$ref": "#/574"
},
{
"$ref": "#/2"
@@ -12974,14 +13148,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/573"
+ "$ref": "#/578"
},
"flags": 1,
"description": "ServiceNowV2 server linked service properties."
},
"type": {
"type": {
- "$ref": "#/577"
+ "$ref": "#/582"
},
"flags": 1,
"description": "Type of linked service."
@@ -13001,7 +13175,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/576"
+ "$ref": "#/581"
},
"flags": 1,
"description": "The authentication type to use."
@@ -13062,10 +13236,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/574"
+ "$ref": "#/579"
},
{
- "$ref": "#/575"
+ "$ref": "#/580"
},
{
"$ref": "#/2"
@@ -13082,14 +13256,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/579"
+ "$ref": "#/584"
},
"flags": 1,
"description": "Properties specific to this linked service type."
},
"type": {
"type": {
- "$ref": "#/584"
+ "$ref": "#/589"
},
"flags": 1,
"description": "Type of linked service."
@@ -13116,7 +13290,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/583"
+ "$ref": "#/588"
},
"flags": 0,
"description": "The authentication type to be used to connect to the FTP server."
@@ -13195,13 +13369,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/580"
+ "$ref": "#/585"
},
{
- "$ref": "#/581"
+ "$ref": "#/586"
},
{
- "$ref": "#/582"
+ "$ref": "#/587"
},
{
"$ref": "#/2"
@@ -13218,14 +13392,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/586"
+ "$ref": "#/591"
},
"flags": 1,
"description": "SharePoint Online List linked service properties."
},
"type": {
"type": {
- "$ref": "#/587"
+ "$ref": "#/592"
},
"flags": 1,
"description": "Type of linked service."
@@ -13304,14 +13478,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/589"
+ "$ref": "#/594"
},
"flags": 1,
"description": "Shopify Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/590"
+ "$ref": "#/595"
},
"flags": 1,
"description": "Type of linked service."
@@ -13376,14 +13550,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/592"
+ "$ref": "#/597"
},
"flags": 1,
"description": "Smartsheet linked service properties."
},
"type": {
"type": {
- "$ref": "#/593"
+ "$ref": "#/598"
},
"flags": 1,
"description": "Type of linked service."
@@ -13420,14 +13594,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/595"
+ "$ref": "#/600"
},
"flags": 1,
"description": "Snowflake linked service properties."
},
"type": {
"type": {
- "$ref": "#/596"
+ "$ref": "#/601"
},
"flags": 1,
"description": "Type of linked service."
@@ -13447,7 +13621,7 @@
},
"password": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -13471,14 +13645,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/598"
+ "$ref": "#/603"
},
"flags": 1,
"description": "Snowflake linked service properties."
},
"type": {
"type": {
- "$ref": "#/603"
+ "$ref": "#/608"
},
"flags": 1,
"description": "Type of linked service."
@@ -13526,7 +13700,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/602"
+ "$ref": "#/607"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -13573,12 +13747,26 @@
"flags": 0,
"description": "The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key."
},
+ "role": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "The default access control role to use in the Snowflake session. Type: string (or Expression with resultType string)."
+ },
"host": {
"type": {
"$ref": "#/11"
},
"flags": 0,
- "description": "The host name of the Snowflake account."
+ "description": "The host name of the Snowflake account. Type: string (or Expression with resultType string)."
+ },
+ "schema": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Schema name for connection. Type: string (or Expression with resultType string)."
},
"encryptedCredential": {
"type": {
@@ -13605,13 +13793,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/599"
+ "$ref": "#/604"
},
{
- "$ref": "#/600"
+ "$ref": "#/605"
},
{
- "$ref": "#/601"
+ "$ref": "#/606"
},
{
"$ref": "#/2"
@@ -13628,14 +13816,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/605"
+ "$ref": "#/610"
},
"flags": 1,
"description": "Spark Server linked service properties."
},
"type": {
"type": {
- "$ref": "#/619"
+ "$ref": "#/624"
},
"flags": 1,
"description": "Type of linked service."
@@ -13662,21 +13850,21 @@
},
"serverType": {
"type": {
- "$ref": "#/609"
+ "$ref": "#/614"
},
"flags": 0,
"description": "The type of Spark server."
},
"thriftTransportProtocol": {
"type": {
- "$ref": "#/613"
+ "$ref": "#/618"
},
"flags": 0,
"description": "The transport protocol to use in the Thrift layer."
},
"authenticationType": {
"type": {
- "$ref": "#/618"
+ "$ref": "#/623"
},
"flags": 1,
"description": "The authentication method used to access the Spark server."
@@ -13762,13 +13950,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/606"
+ "$ref": "#/611"
},
{
- "$ref": "#/607"
+ "$ref": "#/612"
},
{
- "$ref": "#/608"
+ "$ref": "#/613"
},
{
"$ref": "#/2"
@@ -13791,13 +13979,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/610"
+ "$ref": "#/615"
},
{
- "$ref": "#/611"
+ "$ref": "#/616"
},
{
- "$ref": "#/612"
+ "$ref": "#/617"
},
{
"$ref": "#/2"
@@ -13824,16 +14012,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/614"
+ "$ref": "#/619"
},
{
- "$ref": "#/615"
+ "$ref": "#/620"
},
{
- "$ref": "#/616"
+ "$ref": "#/621"
},
{
- "$ref": "#/617"
+ "$ref": "#/622"
},
{
"$ref": "#/2"
@@ -13850,14 +14038,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/621"
+ "$ref": "#/626"
},
"flags": 1,
"description": "SQL Server linked service properties."
},
"type": {
"type": {
- "$ref": "#/626"
+ "$ref": "#/631"
},
"flags": 1,
"description": "Type of linked service."
@@ -13877,7 +14065,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/625"
+ "$ref": "#/630"
},
"flags": 0,
"description": "The type used for authentication. Type: string."
@@ -13905,7 +14093,7 @@
},
"alwaysEncryptedSettings": {
"type": {
- "$ref": "#/167"
+ "$ref": "#/169"
},
"flags": 0,
"description": "Sql always encrypted properties."
@@ -14068,13 +14256,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/622"
+ "$ref": "#/627"
},
{
- "$ref": "#/623"
+ "$ref": "#/628"
},
{
- "$ref": "#/624"
+ "$ref": "#/629"
},
{
"$ref": "#/2"
@@ -14091,14 +14279,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/628"
+ "$ref": "#/633"
},
"flags": 1,
"description": "Square Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/629"
+ "$ref": "#/634"
},
"flags": 1,
"description": "Type of linked service."
@@ -14184,14 +14372,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/631"
+ "$ref": "#/636"
},
"flags": 1,
"description": "Sybase linked service properties."
},
"type": {
"type": {
- "$ref": "#/635"
+ "$ref": "#/640"
},
"flags": 1,
"description": "Type of linked service."
@@ -14225,7 +14413,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/634"
+ "$ref": "#/639"
},
"flags": 0,
"description": "AuthenticationType to be used for connection."
@@ -14265,10 +14453,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/632"
+ "$ref": "#/637"
},
{
- "$ref": "#/633"
+ "$ref": "#/638"
},
{
"$ref": "#/2"
@@ -14285,14 +14473,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/637"
+ "$ref": "#/642"
},
"flags": 1,
"description": "TeamDesk linked service properties."
},
"type": {
"type": {
- "$ref": "#/641"
+ "$ref": "#/646"
},
"flags": 1,
"description": "Type of linked service."
@@ -14305,7 +14493,7 @@
"properties": {
"authenticationType": {
"type": {
- "$ref": "#/640"
+ "$ref": "#/645"
},
"flags": 1,
"description": "The authentication type to use."
@@ -14359,10 +14547,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/638"
+ "$ref": "#/643"
},
{
- "$ref": "#/639"
+ "$ref": "#/644"
},
{
"$ref": "#/2"
@@ -14379,14 +14567,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/643"
+ "$ref": "#/648"
},
"flags": 1,
"description": "Teradata linked service properties."
},
"type": {
"type": {
- "$ref": "#/647"
+ "$ref": "#/652"
},
"flags": 1,
"description": "Type of linked service."
@@ -14413,7 +14601,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/646"
+ "$ref": "#/651"
},
"flags": 0,
"description": "AuthenticationType to be used for connection."
@@ -14495,10 +14683,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/644"
+ "$ref": "#/649"
},
{
- "$ref": "#/645"
+ "$ref": "#/650"
},
{
"$ref": "#/2"
@@ -14515,14 +14703,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/649"
+ "$ref": "#/654"
},
"flags": 1,
"description": "Twilio linked service properties."
},
"type": {
"type": {
- "$ref": "#/650"
+ "$ref": "#/655"
},
"flags": 1,
"description": "Type of linked service."
@@ -14559,14 +14747,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/652"
+ "$ref": "#/657"
},
"flags": 1,
"description": "Vertica linked service properties."
},
"type": {
"type": {
- "$ref": "#/653"
+ "$ref": "#/658"
},
"flags": 1,
"description": "Type of linked service."
@@ -14614,7 +14802,7 @@
},
"pwd": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The Azure key vault secret reference of password in connection string."
@@ -14638,14 +14826,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/655"
+ "$ref": "#/660"
},
"flags": 1,
"description": "Microsoft Fabric Warehouse linked service properties."
},
"type": {
"type": {
- "$ref": "#/656"
+ "$ref": "#/661"
},
"flags": 1,
"description": "Type of linked service."
@@ -14731,14 +14919,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/658"
+ "$ref": "#/663"
},
"flags": 1,
"description": "Web linked service properties."
},
"type": {
"type": {
- "$ref": "#/665"
+ "$ref": "#/670"
},
"flags": 1,
"description": "Type of linked service."
@@ -14760,13 +14948,13 @@
},
"elements": {
"Anonymous": {
- "$ref": "#/659"
+ "$ref": "#/664"
},
"Basic": {
- "$ref": "#/661"
+ "$ref": "#/666"
},
"ClientCertificate": {
- "$ref": "#/663"
+ "$ref": "#/668"
}
}
},
@@ -14776,7 +14964,7 @@
"properties": {
"authenticationType": {
"type": {
- "$ref": "#/660"
+ "$ref": "#/665"
},
"flags": 1,
"description": "Type of authentication used to connect to the web table source."
@@ -14807,7 +14995,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/662"
+ "$ref": "#/667"
},
"flags": 1,
"description": "Type of authentication used to connect to the web table source."
@@ -14838,7 +15026,7 @@
},
"authenticationType": {
"type": {
- "$ref": "#/664"
+ "$ref": "#/669"
},
"flags": 1,
"description": "Type of authentication used to connect to the web table source."
@@ -14859,14 +15047,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/667"
+ "$ref": "#/672"
},
"flags": 1,
"description": "Xero Service linked service properties."
},
"type": {
"type": {
- "$ref": "#/668"
+ "$ref": "#/673"
},
"flags": 1,
"description": "Type of linked service."
@@ -14945,14 +15133,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/670"
+ "$ref": "#/675"
},
"flags": 1,
"description": "Zendesk linked service properties."
},
"type": {
"type": {
- "$ref": "#/674"
+ "$ref": "#/679"
},
"flags": 1,
"description": "Type of linked service."
@@ -14965,7 +15153,7 @@
"properties": {
"authenticationType": {
"type": {
- "$ref": "#/673"
+ "$ref": "#/678"
},
"flags": 1,
"description": "The authentication type to use."
@@ -15019,10 +15207,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/671"
+ "$ref": "#/676"
},
{
- "$ref": "#/672"
+ "$ref": "#/677"
},
{
"$ref": "#/2"
@@ -15039,14 +15227,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/676"
+ "$ref": "#/681"
},
"flags": 1,
"description": "Zoho server linked service properties."
},
"type": {
"type": {
- "$ref": "#/677"
+ "$ref": "#/682"
},
"flags": 1,
"description": "Type of linked service."
@@ -15149,21 +15337,21 @@
},
"type": {
"type": {
- "$ref": "#/679"
+ "$ref": "#/684"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/680"
+ "$ref": "#/685"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/682"
+ "$ref": "#/687"
},
"flags": 1,
"description": "Dataset properties."
@@ -15212,21 +15400,21 @@
},
"parameters": {
"type": {
- "$ref": "#/683"
+ "$ref": "#/688"
},
"flags": 0,
"description": "Parameters for dataset."
},
"annotations": {
"type": {
- "$ref": "#/684"
+ "$ref": "#/689"
},
"flags": 0,
"description": "List of tags that can be used for describing the Dataset."
},
"folder": {
"type": {
- "$ref": "#/685"
+ "$ref": "#/690"
},
"flags": 0,
"description": "The folder that this Dataset is in. If not specified, Dataset will appear at the root level."
@@ -15234,319 +15422,319 @@
},
"elements": {
"AmazonMWSObject": {
- "$ref": "#/686"
+ "$ref": "#/691"
},
"AmazonRdsForOracleTable": {
- "$ref": "#/689"
+ "$ref": "#/694"
},
"AmazonRdsForSqlServerTable": {
- "$ref": "#/692"
+ "$ref": "#/697"
},
"AmazonRedshiftTable": {
- "$ref": "#/695"
+ "$ref": "#/700"
},
"AmazonS3Object": {
- "$ref": "#/698"
+ "$ref": "#/703"
},
"Avro": {
- "$ref": "#/713"
+ "$ref": "#/718"
},
"AzureBlob": {
- "$ref": "#/746"
+ "$ref": "#/751"
},
"AzureBlobFSFile": {
- "$ref": "#/749"
+ "$ref": "#/754"
},
"AzureDataExplorerTable": {
- "$ref": "#/752"
+ "$ref": "#/757"
},
"AzureDataLakeStoreFile": {
- "$ref": "#/755"
+ "$ref": "#/760"
},
"AzureDatabricksDeltaLakeDataset": {
- "$ref": "#/758"
+ "$ref": "#/763"
},
"AzureMariaDBTable": {
- "$ref": "#/761"
+ "$ref": "#/766"
},
"AzureMySqlTable": {
- "$ref": "#/763"
+ "$ref": "#/768"
},
"AzurePostgreSqlTable": {
- "$ref": "#/766"
+ "$ref": "#/771"
},
"AzureSearchIndex": {
- "$ref": "#/769"
+ "$ref": "#/774"
},
"AzureSqlDWTable": {
- "$ref": "#/772"
+ "$ref": "#/777"
},
"AzureSqlMITable": {
- "$ref": "#/775"
+ "$ref": "#/780"
},
"AzureSqlTable": {
- "$ref": "#/778"
+ "$ref": "#/783"
},
"AzureTable": {
- "$ref": "#/781"
+ "$ref": "#/786"
},
"Binary": {
- "$ref": "#/784"
+ "$ref": "#/789"
},
"CassandraTable": {
- "$ref": "#/787"
+ "$ref": "#/792"
},
"CommonDataServiceForAppsEntity": {
- "$ref": "#/790"
+ "$ref": "#/795"
},
"ConcurObject": {
- "$ref": "#/793"
+ "$ref": "#/798"
},
"CosmosDbMongoDbApiCollection": {
- "$ref": "#/795"
+ "$ref": "#/800"
},
"CosmosDbSqlApiCollection": {
- "$ref": "#/798"
+ "$ref": "#/803"
},
"CouchbaseTable": {
- "$ref": "#/801"
+ "$ref": "#/806"
},
"CustomDataset": {
- "$ref": "#/803"
+ "$ref": "#/808"
},
"Db2Table": {
- "$ref": "#/805"
+ "$ref": "#/810"
},
"DelimitedText": {
- "$ref": "#/808"
+ "$ref": "#/813"
},
"DocumentDbCollection": {
- "$ref": "#/811"
+ "$ref": "#/816"
},
"DrillTable": {
- "$ref": "#/814"
+ "$ref": "#/819"
},
"DynamicsAXResource": {
- "$ref": "#/817"
+ "$ref": "#/822"
},
"DynamicsCrmEntity": {
- "$ref": "#/820"
+ "$ref": "#/825"
},
"DynamicsEntity": {
- "$ref": "#/823"
+ "$ref": "#/828"
},
"EloquaObject": {
- "$ref": "#/826"
+ "$ref": "#/831"
},
"Excel": {
- "$ref": "#/828"
+ "$ref": "#/833"
},
"FileShare": {
- "$ref": "#/831"
+ "$ref": "#/836"
},
"GoogleAdWordsObject": {
- "$ref": "#/834"
+ "$ref": "#/839"
},
"GoogleBigQueryObject": {
- "$ref": "#/836"
+ "$ref": "#/841"
},
"GoogleBigQueryV2Object": {
- "$ref": "#/839"
+ "$ref": "#/844"
},
"GreenplumTable": {
- "$ref": "#/842"
+ "$ref": "#/847"
},
"HBaseObject": {
- "$ref": "#/845"
+ "$ref": "#/850"
},
"HiveObject": {
- "$ref": "#/847"
+ "$ref": "#/852"
},
"HttpFile": {
- "$ref": "#/850"
+ "$ref": "#/855"
},
"HubspotObject": {
- "$ref": "#/853"
+ "$ref": "#/858"
},
"Iceberg": {
- "$ref": "#/855"
+ "$ref": "#/860"
},
"ImpalaObject": {
- "$ref": "#/858"
+ "$ref": "#/863"
},
"InformixTable": {
- "$ref": "#/861"
+ "$ref": "#/866"
},
"JiraObject": {
- "$ref": "#/864"
+ "$ref": "#/869"
},
"Json": {
- "$ref": "#/866"
+ "$ref": "#/871"
},
"LakehouseTable": {
- "$ref": "#/869"
+ "$ref": "#/874"
},
"MagentoObject": {
- "$ref": "#/872"
+ "$ref": "#/877"
},
"MariaDBTable": {
- "$ref": "#/874"
+ "$ref": "#/879"
},
"MarketoObject": {
- "$ref": "#/876"
+ "$ref": "#/881"
},
"MicrosoftAccessTable": {
- "$ref": "#/878"
+ "$ref": "#/883"
},
"MongoDbAtlasCollection": {
- "$ref": "#/881"
+ "$ref": "#/886"
},
"MongoDbCollection": {
- "$ref": "#/884"
+ "$ref": "#/889"
},
"MongoDbV2Collection": {
- "$ref": "#/887"
+ "$ref": "#/892"
},
"MySqlTable": {
- "$ref": "#/890"
+ "$ref": "#/895"
},
"NetezzaTable": {
- "$ref": "#/893"
+ "$ref": "#/898"
},
"ODataResource": {
- "$ref": "#/896"
+ "$ref": "#/901"
},
"OdbcTable": {
- "$ref": "#/899"
+ "$ref": "#/904"
},
"Office365Table": {
- "$ref": "#/902"
+ "$ref": "#/907"
},
"OracleServiceCloudObject": {
- "$ref": "#/905"
+ "$ref": "#/910"
},
"OracleTable": {
- "$ref": "#/907"
+ "$ref": "#/912"
},
"Orc": {
- "$ref": "#/910"
+ "$ref": "#/915"
},
"Parquet": {
- "$ref": "#/913"
+ "$ref": "#/918"
},
"PaypalObject": {
- "$ref": "#/916"
+ "$ref": "#/921"
},
"PhoenixObject": {
- "$ref": "#/918"
+ "$ref": "#/923"
},
"PostgreSqlTable": {
- "$ref": "#/921"
+ "$ref": "#/926"
},
"PostgreSqlV2Table": {
- "$ref": "#/924"
+ "$ref": "#/929"
},
"PrestoObject": {
- "$ref": "#/927"
+ "$ref": "#/932"
},
"QuickBooksObject": {
- "$ref": "#/930"
+ "$ref": "#/935"
},
"RelationalTable": {
- "$ref": "#/932"
+ "$ref": "#/937"
},
"ResponsysObject": {
- "$ref": "#/935"
+ "$ref": "#/940"
},
"RestResource": {
- "$ref": "#/937"
+ "$ref": "#/942"
},
"SalesforceMarketingCloudObject": {
- "$ref": "#/942"
+ "$ref": "#/947"
},
"SalesforceObject": {
- "$ref": "#/944"
+ "$ref": "#/949"
},
"SalesforceServiceCloudObject": {
- "$ref": "#/947"
+ "$ref": "#/952"
},
"SalesforceServiceCloudV2Object": {
- "$ref": "#/950"
+ "$ref": "#/955"
},
"SalesforceV2Object": {
- "$ref": "#/953"
+ "$ref": "#/958"
},
"SapBwCube": {
- "$ref": "#/956"
+ "$ref": "#/961"
},
"SapCloudForCustomerResource": {
- "$ref": "#/958"
+ "$ref": "#/963"
},
"SapEccResource": {
- "$ref": "#/961"
+ "$ref": "#/966"
},
"SapHanaTable": {
- "$ref": "#/964"
+ "$ref": "#/969"
},
"SapOdpResource": {
- "$ref": "#/967"
+ "$ref": "#/972"
},
"SapOpenHubTable": {
- "$ref": "#/970"
+ "$ref": "#/975"
},
"SapTableResource": {
- "$ref": "#/973"
+ "$ref": "#/978"
},
"ServiceNowObject": {
- "$ref": "#/976"
+ "$ref": "#/981"
},
"ServiceNowV2Object": {
- "$ref": "#/978"
+ "$ref": "#/983"
},
"SharePointOnlineListResource": {
- "$ref": "#/980"
+ "$ref": "#/989"
},
"ShopifyObject": {
- "$ref": "#/983"
+ "$ref": "#/992"
},
"SnowflakeTable": {
- "$ref": "#/985"
+ "$ref": "#/994"
},
"SnowflakeV2Table": {
- "$ref": "#/988"
+ "$ref": "#/997"
},
"SparkObject": {
- "$ref": "#/990"
+ "$ref": "#/999"
},
"SqlServerTable": {
- "$ref": "#/993"
+ "$ref": "#/1002"
},
"SquareObject": {
- "$ref": "#/996"
+ "$ref": "#/1005"
},
"SybaseTable": {
- "$ref": "#/998"
+ "$ref": "#/1007"
},
"TeradataTable": {
- "$ref": "#/1001"
+ "$ref": "#/1010"
},
"VerticaTable": {
- "$ref": "#/1004"
+ "$ref": "#/1013"
},
"WarehouseTable": {
- "$ref": "#/1007"
+ "$ref": "#/1016"
},
"WebTable": {
- "$ref": "#/1010"
+ "$ref": "#/1019"
},
"XeroObject": {
- "$ref": "#/1013"
+ "$ref": "#/1022"
},
"Xml": {
- "$ref": "#/1015"
+ "$ref": "#/1024"
},
"ZohoObject": {
- "$ref": "#/1018"
+ "$ref": "#/1027"
}
}
},
@@ -15583,14 +15771,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/688"
+ "$ref": "#/693"
},
"flags": 1,
"description": "Type of dataset."
@@ -15620,14 +15808,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/690"
+ "$ref": "#/695"
},
"flags": 0,
"description": "AmazonRdsForOracle dataset properties."
},
"type": {
"type": {
- "$ref": "#/691"
+ "$ref": "#/696"
},
"flags": 1,
"description": "Type of dataset."
@@ -15664,14 +15852,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/693"
+ "$ref": "#/698"
},
"flags": 0,
"description": "The Amazon RDS for SQL Server dataset properties."
},
"type": {
"type": {
- "$ref": "#/694"
+ "$ref": "#/699"
},
"flags": 1,
"description": "Type of dataset."
@@ -15708,14 +15896,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/696"
+ "$ref": "#/701"
},
"flags": 0,
"description": "Amazon Redshift table dataset properties."
},
"type": {
"type": {
- "$ref": "#/697"
+ "$ref": "#/702"
},
"flags": 1,
"description": "Type of dataset."
@@ -15759,14 +15947,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/699"
+ "$ref": "#/704"
},
"flags": 1,
"description": "Amazon S3 dataset properties."
},
"type": {
"type": {
- "$ref": "#/712"
+ "$ref": "#/717"
},
"flags": 1,
"description": "Type of dataset."
@@ -15821,14 +16009,14 @@
},
"format": {
"type": {
- "$ref": "#/700"
+ "$ref": "#/705"
},
"flags": 0,
"description": "The format of files."
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the Amazon S3 object."
@@ -15857,19 +16045,19 @@
},
"elements": {
"AvroFormat": {
- "$ref": "#/701"
+ "$ref": "#/706"
},
"JsonFormat": {
- "$ref": "#/703"
+ "$ref": "#/708"
},
"OrcFormat": {
- "$ref": "#/705"
+ "$ref": "#/710"
},
"ParquetFormat": {
- "$ref": "#/707"
+ "$ref": "#/712"
},
"TextFormat": {
- "$ref": "#/709"
+ "$ref": "#/714"
}
}
},
@@ -15879,7 +16067,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/702"
+ "$ref": "#/707"
},
"flags": 1,
"description": "Type of dataset storage format."
@@ -15931,7 +16119,7 @@
},
"type": {
"type": {
- "$ref": "#/704"
+ "$ref": "#/709"
},
"flags": 1,
"description": "Type of dataset storage format."
@@ -15948,7 +16136,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/706"
+ "$ref": "#/711"
},
"flags": 1,
"description": "Type of dataset storage format."
@@ -15965,7 +16153,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/708"
+ "$ref": "#/713"
},
"flags": 1,
"description": "Type of dataset storage format."
@@ -16045,7 +16233,7 @@
},
"type": {
"type": {
- "$ref": "#/710"
+ "$ref": "#/715"
},
"flags": 1,
"description": "Type of dataset storage format."
@@ -16089,14 +16277,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/714"
+ "$ref": "#/719"
},
"flags": 0,
"description": "Avro dataset properties."
},
"type": {
"type": {
- "$ref": "#/745"
+ "$ref": "#/750"
},
"flags": 1,
"description": "Type of dataset."
@@ -16109,7 +16297,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the avro storage."
@@ -16123,7 +16311,7 @@
},
"avroCompressionLevel": {
"type": {
- "$ref": "#/744"
+ "$ref": "#/749"
},
"flags": 0
}
@@ -16151,46 +16339,46 @@
},
"elements": {
"AmazonS3CompatibleLocation": {
- "$ref": "#/716"
+ "$ref": "#/721"
},
"AmazonS3Location": {
- "$ref": "#/718"
+ "$ref": "#/723"
},
"AzureBlobFSLocation": {
- "$ref": "#/720"
+ "$ref": "#/725"
},
"AzureBlobStorageLocation": {
- "$ref": "#/722"
+ "$ref": "#/727"
},
"AzureDataLakeStoreLocation": {
- "$ref": "#/724"
+ "$ref": "#/729"
},
"AzureFileStorageLocation": {
- "$ref": "#/726"
+ "$ref": "#/731"
},
"FileServerLocation": {
- "$ref": "#/728"
+ "$ref": "#/733"
},
"FtpServerLocation": {
- "$ref": "#/730"
+ "$ref": "#/735"
},
"GoogleCloudStorageLocation": {
- "$ref": "#/732"
+ "$ref": "#/737"
},
"HdfsLocation": {
- "$ref": "#/734"
+ "$ref": "#/739"
},
"HttpServerLocation": {
- "$ref": "#/736"
+ "$ref": "#/741"
},
"LakeHouseLocation": {
- "$ref": "#/738"
+ "$ref": "#/743"
},
"OracleCloudStorageLocation": {
- "$ref": "#/740"
+ "$ref": "#/745"
},
"SftpLocation": {
- "$ref": "#/742"
+ "$ref": "#/747"
}
}
},
@@ -16214,7 +16402,7 @@
},
"type": {
"type": {
- "$ref": "#/717"
+ "$ref": "#/722"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16245,7 +16433,7 @@
},
"type": {
"type": {
- "$ref": "#/719"
+ "$ref": "#/724"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16269,7 +16457,7 @@
},
"type": {
"type": {
- "$ref": "#/721"
+ "$ref": "#/726"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16293,7 +16481,7 @@
},
"type": {
"type": {
- "$ref": "#/723"
+ "$ref": "#/728"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16310,7 +16498,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/725"
+ "$ref": "#/730"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16327,7 +16515,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/727"
+ "$ref": "#/732"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16344,7 +16532,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/729"
+ "$ref": "#/734"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16361,7 +16549,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/731"
+ "$ref": "#/736"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16392,7 +16580,7 @@
},
"type": {
"type": {
- "$ref": "#/733"
+ "$ref": "#/738"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16409,7 +16597,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/735"
+ "$ref": "#/740"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16433,7 +16621,7 @@
},
"type": {
"type": {
- "$ref": "#/737"
+ "$ref": "#/742"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16450,7 +16638,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/739"
+ "$ref": "#/744"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16481,7 +16669,7 @@
},
"type": {
"type": {
- "$ref": "#/741"
+ "$ref": "#/746"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16498,7 +16686,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/743"
+ "$ref": "#/748"
},
"flags": 1,
"description": "Type of dataset storage location."
@@ -16524,14 +16712,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/747"
+ "$ref": "#/752"
},
"flags": 0,
"description": "Azure Blob dataset properties."
},
"type": {
"type": {
- "$ref": "#/748"
+ "$ref": "#/753"
},
"flags": 1,
"description": "Type of dataset."
@@ -16579,14 +16767,14 @@
},
"format": {
"type": {
- "$ref": "#/700"
+ "$ref": "#/705"
},
"flags": 0,
"description": "The format of the Azure Blob storage."
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the blob storage."
@@ -16603,14 +16791,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/750"
+ "$ref": "#/755"
},
"flags": 0,
"description": "Azure Data Lake Storage Gen2 dataset properties."
},
"type": {
"type": {
- "$ref": "#/751"
+ "$ref": "#/756"
},
"flags": 1,
"description": "Type of dataset."
@@ -16637,14 +16825,14 @@
},
"format": {
"type": {
- "$ref": "#/700"
+ "$ref": "#/705"
},
"flags": 0,
"description": "The format of the Azure Data Lake Storage Gen2 storage."
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the blob storage."
@@ -16661,14 +16849,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/753"
+ "$ref": "#/758"
},
"flags": 1,
"description": "Azure Data Explorer (Kusto) dataset properties."
},
"type": {
"type": {
- "$ref": "#/754"
+ "$ref": "#/759"
},
"flags": 1,
"description": "Type of dataset."
@@ -16698,14 +16886,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/756"
+ "$ref": "#/761"
},
"flags": 0,
"description": "Azure Data Lake Store dataset properties."
},
"type": {
"type": {
- "$ref": "#/757"
+ "$ref": "#/762"
},
"flags": 1,
"description": "Type of dataset."
@@ -16732,14 +16920,14 @@
},
"format": {
"type": {
- "$ref": "#/700"
+ "$ref": "#/705"
},
"flags": 0,
"description": "The format of the Data Lake Store."
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the item(s) in the Azure Data Lake Store."
@@ -16756,14 +16944,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/759"
+ "$ref": "#/764"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/760"
+ "$ref": "#/765"
},
"flags": 1,
"description": "Type of dataset."
@@ -16800,14 +16988,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/762"
+ "$ref": "#/767"
},
"flags": 1,
"description": "Type of dataset."
@@ -16824,14 +17012,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/764"
+ "$ref": "#/769"
},
"flags": 1,
"description": "Azure MySQL database dataset properties."
},
"type": {
"type": {
- "$ref": "#/765"
+ "$ref": "#/770"
},
"flags": 1,
"description": "Type of dataset."
@@ -16868,14 +17056,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/767"
+ "$ref": "#/772"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/768"
+ "$ref": "#/773"
},
"flags": 1,
"description": "Type of dataset."
@@ -16919,14 +17107,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/770"
+ "$ref": "#/775"
},
"flags": 1,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/771"
+ "$ref": "#/776"
},
"flags": 1,
"description": "Type of dataset."
@@ -16956,14 +17144,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/773"
+ "$ref": "#/778"
},
"flags": 0,
"description": "Azure SQL Data Warehouse dataset properties."
},
"type": {
"type": {
- "$ref": "#/774"
+ "$ref": "#/779"
},
"flags": 1,
"description": "Type of dataset."
@@ -17007,14 +17195,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/776"
+ "$ref": "#/781"
},
"flags": 0,
"description": "Azure SQL Managed Instance dataset properties."
},
"type": {
"type": {
- "$ref": "#/777"
+ "$ref": "#/782"
},
"flags": 1,
"description": "Type of dataset."
@@ -17058,14 +17246,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/779"
+ "$ref": "#/784"
},
"flags": 0,
"description": "Azure SQL dataset properties."
},
"type": {
"type": {
- "$ref": "#/780"
+ "$ref": "#/785"
},
"flags": 1,
"description": "Type of dataset."
@@ -17109,14 +17297,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/782"
+ "$ref": "#/787"
},
"flags": 1,
"description": "Azure Table dataset properties."
},
"type": {
"type": {
- "$ref": "#/783"
+ "$ref": "#/788"
},
"flags": 1,
"description": "Type of dataset."
@@ -17146,14 +17334,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/785"
+ "$ref": "#/790"
},
"flags": 0,
"description": "Binary dataset properties."
},
"type": {
"type": {
- "$ref": "#/786"
+ "$ref": "#/791"
},
"flags": 1,
"description": "Type of dataset."
@@ -17166,14 +17354,14 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the Binary storage."
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the binary dataset."
@@ -17190,14 +17378,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/788"
+ "$ref": "#/793"
},
"flags": 0,
"description": "Cassandra dataset properties."
},
"type": {
"type": {
- "$ref": "#/789"
+ "$ref": "#/794"
},
"flags": 1,
"description": "Type of dataset."
@@ -17234,14 +17422,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/791"
+ "$ref": "#/796"
},
"flags": 0,
"description": "Common Data Service for Apps entity dataset properties."
},
"type": {
"type": {
- "$ref": "#/792"
+ "$ref": "#/797"
},
"flags": 1,
"description": "Type of dataset."
@@ -17271,14 +17459,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/794"
+ "$ref": "#/799"
},
"flags": 1,
"description": "Type of dataset."
@@ -17295,14 +17483,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/796"
+ "$ref": "#/801"
},
"flags": 1,
"description": "CosmosDB (MongoDB API) database dataset properties."
},
"type": {
"type": {
- "$ref": "#/797"
+ "$ref": "#/802"
},
"flags": 1,
"description": "Type of dataset."
@@ -17332,14 +17520,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/799"
+ "$ref": "#/804"
},
"flags": 1,
"description": "CosmosDB (SQL API) Collection dataset properties."
},
"type": {
"type": {
- "$ref": "#/800"
+ "$ref": "#/805"
},
"flags": 1,
"description": "Type of dataset."
@@ -17369,14 +17557,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/802"
+ "$ref": "#/807"
},
"flags": 1,
"description": "Type of dataset."
@@ -17400,7 +17588,7 @@
},
"type": {
"type": {
- "$ref": "#/804"
+ "$ref": "#/809"
},
"flags": 1,
"description": "Type of dataset."
@@ -17417,14 +17605,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/806"
+ "$ref": "#/811"
},
"flags": 0,
"description": "Db2 table dataset properties."
},
"type": {
"type": {
- "$ref": "#/807"
+ "$ref": "#/812"
},
"flags": 1,
"description": "Type of dataset."
@@ -17468,14 +17656,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/809"
+ "$ref": "#/814"
},
"flags": 0,
"description": "Delimited text dataset properties."
},
"type": {
"type": {
- "$ref": "#/810"
+ "$ref": "#/815"
},
"flags": 1,
"description": "Type of dataset."
@@ -17488,7 +17676,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the delimited text storage."
@@ -17568,14 +17756,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/812"
+ "$ref": "#/817"
},
"flags": 1,
"description": "DocumentDB Collection dataset properties."
},
"type": {
"type": {
- "$ref": "#/813"
+ "$ref": "#/818"
},
"flags": 1,
"description": "Type of dataset."
@@ -17605,14 +17793,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/815"
+ "$ref": "#/820"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/816"
+ "$ref": "#/821"
},
"flags": 1,
"description": "Type of dataset."
@@ -17656,14 +17844,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/818"
+ "$ref": "#/823"
},
"flags": 1,
"description": "Dynamics AX OData resource dataset properties."
},
"type": {
"type": {
- "$ref": "#/819"
+ "$ref": "#/824"
},
"flags": 1,
"description": "Type of dataset."
@@ -17693,14 +17881,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/821"
+ "$ref": "#/826"
},
"flags": 0,
"description": "Dynamics CRM entity dataset properties."
},
"type": {
"type": {
- "$ref": "#/822"
+ "$ref": "#/827"
},
"flags": 1,
"description": "Type of dataset."
@@ -17730,14 +17918,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/824"
+ "$ref": "#/829"
},
"flags": 0,
"description": "Dynamics entity dataset properties."
},
"type": {
"type": {
- "$ref": "#/825"
+ "$ref": "#/830"
},
"flags": 1,
"description": "Type of dataset."
@@ -17767,14 +17955,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/827"
+ "$ref": "#/832"
},
"flags": 1,
"description": "Type of dataset."
@@ -17791,14 +17979,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/829"
+ "$ref": "#/834"
},
"flags": 0,
"description": "Excel dataset properties."
},
"type": {
"type": {
- "$ref": "#/830"
+ "$ref": "#/835"
},
"flags": 1,
"description": "Type of dataset."
@@ -17811,7 +17999,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the excel storage."
@@ -17846,7 +18034,7 @@
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the json dataset."
@@ -17870,14 +18058,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/832"
+ "$ref": "#/837"
},
"flags": 0,
"description": "On-premises file system dataset properties."
},
"type": {
"type": {
- "$ref": "#/833"
+ "$ref": "#/838"
},
"flags": 1,
"description": "Type of dataset."
@@ -17918,7 +18106,7 @@
},
"format": {
"type": {
- "$ref": "#/700"
+ "$ref": "#/705"
},
"flags": 0,
"description": "The format of the files."
@@ -17932,7 +18120,7 @@
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the file system."
@@ -17949,14 +18137,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/835"
+ "$ref": "#/840"
},
"flags": 1,
"description": "Type of dataset."
@@ -17973,14 +18161,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/837"
+ "$ref": "#/842"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/838"
+ "$ref": "#/843"
},
"flags": 1,
"description": "Type of dataset."
@@ -18024,14 +18212,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/840"
+ "$ref": "#/845"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/841"
+ "$ref": "#/846"
},
"flags": 1,
"description": "Type of dataset."
@@ -18068,14 +18256,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/843"
+ "$ref": "#/848"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/844"
+ "$ref": "#/849"
},
"flags": 1,
"description": "Type of dataset."
@@ -18119,14 +18307,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/846"
+ "$ref": "#/851"
},
"flags": 1,
"description": "Type of dataset."
@@ -18143,14 +18331,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/848"
+ "$ref": "#/853"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/849"
+ "$ref": "#/854"
},
"flags": 1,
"description": "Type of dataset."
@@ -18194,14 +18382,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/851"
+ "$ref": "#/856"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/852"
+ "$ref": "#/857"
},
"flags": 1,
"description": "Type of dataset."
@@ -18242,14 +18430,14 @@
},
"format": {
"type": {
- "$ref": "#/700"
+ "$ref": "#/705"
},
"flags": 0,
"description": "The format of files."
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used on files."
@@ -18266,14 +18454,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/854"
+ "$ref": "#/859"
},
"flags": 1,
"description": "Type of dataset."
@@ -18290,14 +18478,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/856"
+ "$ref": "#/861"
},
"flags": 0,
"description": "Iceberg dataset properties."
},
"type": {
"type": {
- "$ref": "#/857"
+ "$ref": "#/862"
},
"flags": 1,
"description": "Type of dataset."
@@ -18310,7 +18498,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the iceberg storage. Setting a file name is not allowed for iceberg format."
@@ -18327,14 +18515,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/859"
+ "$ref": "#/864"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/860"
+ "$ref": "#/865"
},
"flags": 1,
"description": "Type of dataset."
@@ -18378,14 +18566,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/862"
+ "$ref": "#/867"
},
"flags": 0,
"description": "Informix table dataset properties."
},
"type": {
"type": {
- "$ref": "#/863"
+ "$ref": "#/868"
},
"flags": 1,
"description": "Type of dataset."
@@ -18415,14 +18603,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/865"
+ "$ref": "#/870"
},
"flags": 1,
"description": "Type of dataset."
@@ -18439,14 +18627,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/867"
+ "$ref": "#/872"
},
"flags": 0,
"description": "Json dataset properties."
},
"type": {
"type": {
- "$ref": "#/868"
+ "$ref": "#/873"
},
"flags": 1,
"description": "Type of dataset."
@@ -18459,7 +18647,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the json data storage."
@@ -18473,7 +18661,7 @@
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the json dataset."
@@ -18490,14 +18678,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/870"
+ "$ref": "#/875"
},
"flags": 0,
"description": "Microsoft Fabric Lakehouse Table dataset properties."
},
"type": {
"type": {
- "$ref": "#/871"
+ "$ref": "#/876"
},
"flags": 1,
"description": "Type of dataset."
@@ -18534,14 +18722,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/873"
+ "$ref": "#/878"
},
"flags": 1,
"description": "Type of dataset."
@@ -18558,14 +18746,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/875"
+ "$ref": "#/880"
},
"flags": 1,
"description": "Type of dataset."
@@ -18582,14 +18770,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/877"
+ "$ref": "#/882"
},
"flags": 1,
"description": "Type of dataset."
@@ -18606,14 +18794,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/879"
+ "$ref": "#/884"
},
"flags": 0,
"description": "Microsoft Access table dataset properties."
},
"type": {
"type": {
- "$ref": "#/880"
+ "$ref": "#/885"
},
"flags": 1,
"description": "Type of dataset."
@@ -18643,14 +18831,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/882"
+ "$ref": "#/887"
},
"flags": 1,
"description": "MongoDB Atlas database dataset properties."
},
"type": {
"type": {
- "$ref": "#/883"
+ "$ref": "#/888"
},
"flags": 1,
"description": "Type of dataset."
@@ -18680,14 +18868,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/885"
+ "$ref": "#/890"
},
"flags": 1,
"description": "MongoDB database dataset properties."
},
"type": {
"type": {
- "$ref": "#/886"
+ "$ref": "#/891"
},
"flags": 1,
"description": "Type of dataset."
@@ -18717,14 +18905,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/888"
+ "$ref": "#/893"
},
"flags": 1,
"description": "MongoDB database dataset properties."
},
"type": {
"type": {
- "$ref": "#/889"
+ "$ref": "#/894"
},
"flags": 1,
"description": "Type of dataset."
@@ -18754,14 +18942,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/891"
+ "$ref": "#/896"
},
"flags": 0,
"description": "MySQL table dataset properties."
},
"type": {
"type": {
- "$ref": "#/892"
+ "$ref": "#/897"
},
"flags": 1,
"description": "Type of dataset."
@@ -18791,14 +18979,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/894"
+ "$ref": "#/899"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/895"
+ "$ref": "#/900"
},
"flags": 1,
"description": "Type of dataset."
@@ -18842,14 +19030,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/897"
+ "$ref": "#/902"
},
"flags": 0,
"description": "OData dataset properties."
},
"type": {
"type": {
- "$ref": "#/898"
+ "$ref": "#/903"
},
"flags": 1,
"description": "Type of dataset."
@@ -18879,14 +19067,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/900"
+ "$ref": "#/905"
},
"flags": 0,
"description": "ODBC table dataset properties."
},
"type": {
"type": {
- "$ref": "#/901"
+ "$ref": "#/906"
},
"flags": 1,
"description": "Type of dataset."
@@ -18916,14 +19104,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/903"
+ "$ref": "#/908"
},
"flags": 1,
"description": "Office365 dataset properties."
},
"type": {
"type": {
- "$ref": "#/904"
+ "$ref": "#/909"
},
"flags": 1,
"description": "Type of dataset."
@@ -18960,14 +19148,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/906"
+ "$ref": "#/911"
},
"flags": 1,
"description": "Type of dataset."
@@ -18984,14 +19172,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/908"
+ "$ref": "#/913"
},
"flags": 0,
"description": "On-premises Oracle dataset properties."
},
"type": {
"type": {
- "$ref": "#/909"
+ "$ref": "#/914"
},
"flags": 1,
"description": "Type of dataset."
@@ -19035,14 +19223,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/911"
+ "$ref": "#/916"
},
"flags": 0,
"description": "ORC dataset properties."
},
"type": {
"type": {
- "$ref": "#/912"
+ "$ref": "#/917"
},
"flags": 1,
"description": "Type of dataset."
@@ -19055,7 +19243,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the ORC data storage."
@@ -19079,14 +19267,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/914"
+ "$ref": "#/919"
},
"flags": 0,
"description": "Parquet dataset properties."
},
"type": {
"type": {
- "$ref": "#/915"
+ "$ref": "#/920"
},
"flags": 1,
"description": "Type of dataset."
@@ -19099,7 +19287,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the parquet storage."
@@ -19123,14 +19311,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/917"
+ "$ref": "#/922"
},
"flags": 1,
"description": "Type of dataset."
@@ -19147,14 +19335,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/919"
+ "$ref": "#/924"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/920"
+ "$ref": "#/925"
},
"flags": 1,
"description": "Type of dataset."
@@ -19198,14 +19386,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/922"
+ "$ref": "#/927"
},
"flags": 0,
"description": "PostgreSQL table dataset properties."
},
"type": {
"type": {
- "$ref": "#/923"
+ "$ref": "#/928"
},
"flags": 1,
"description": "Type of dataset."
@@ -19249,14 +19437,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/925"
+ "$ref": "#/930"
},
"flags": 0,
"description": "PostgreSQLV2 table dataset properties."
},
"type": {
"type": {
- "$ref": "#/926"
+ "$ref": "#/931"
},
"flags": 1,
"description": "Type of dataset."
@@ -19293,14 +19481,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/928"
+ "$ref": "#/933"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/929"
+ "$ref": "#/934"
},
"flags": 1,
"description": "Type of dataset."
@@ -19344,14 +19532,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/931"
+ "$ref": "#/936"
},
"flags": 1,
"description": "Type of dataset."
@@ -19368,14 +19556,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/933"
+ "$ref": "#/938"
},
"flags": 0,
"description": "Relational table dataset properties."
},
"type": {
"type": {
- "$ref": "#/934"
+ "$ref": "#/939"
},
"flags": 1,
"description": "Type of dataset."
@@ -19405,14 +19593,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/936"
+ "$ref": "#/941"
},
"flags": 1,
"description": "Type of dataset."
@@ -19429,14 +19617,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/938"
+ "$ref": "#/943"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/941"
+ "$ref": "#/946"
},
"flags": 1,
"description": "Type of dataset."
@@ -19470,14 +19658,14 @@
},
"additionalHeaders": {
"type": {
- "$ref": "#/939"
+ "$ref": "#/944"
},
"flags": 0,
"description": "The additional HTTP headers in the request to the RESTful API."
},
"paginationRules": {
"type": {
- "$ref": "#/940"
+ "$ref": "#/945"
},
"flags": 0,
"description": "The pagination rules to compose next page requests."
@@ -19510,14 +19698,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/943"
+ "$ref": "#/948"
},
"flags": 1,
"description": "Type of dataset."
@@ -19534,14 +19722,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/945"
+ "$ref": "#/950"
},
"flags": 0,
"description": "Salesforce object dataset properties."
},
"type": {
"type": {
- "$ref": "#/946"
+ "$ref": "#/951"
},
"flags": 1,
"description": "Type of dataset."
@@ -19571,14 +19759,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/948"
+ "$ref": "#/953"
},
"flags": 0,
"description": "Salesforce Service Cloud object dataset properties."
},
"type": {
"type": {
- "$ref": "#/949"
+ "$ref": "#/954"
},
"flags": 1,
"description": "Type of dataset."
@@ -19608,14 +19796,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/951"
+ "$ref": "#/956"
},
"flags": 0,
"description": "Salesforce Service Cloud V2 object dataset properties."
},
"type": {
"type": {
- "$ref": "#/952"
+ "$ref": "#/957"
},
"flags": 1,
"description": "Type of dataset."
@@ -19652,14 +19840,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/954"
+ "$ref": "#/959"
},
"flags": 0,
"description": "Salesforce V2 object dataset properties."
},
"type": {
"type": {
- "$ref": "#/955"
+ "$ref": "#/960"
},
"flags": 1,
"description": "Type of dataset."
@@ -19696,7 +19884,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/957"
+ "$ref": "#/962"
},
"flags": 1,
"description": "Type of dataset."
@@ -19713,14 +19901,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/959"
+ "$ref": "#/964"
},
"flags": 1,
"description": "SAP Cloud For Customer OData resource dataset properties."
},
"type": {
"type": {
- "$ref": "#/960"
+ "$ref": "#/965"
},
"flags": 1,
"description": "Type of dataset."
@@ -19750,14 +19938,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/962"
+ "$ref": "#/967"
},
"flags": 1,
"description": "SAP ECC OData resource dataset properties."
},
"type": {
"type": {
- "$ref": "#/963"
+ "$ref": "#/968"
},
"flags": 1,
"description": "Type of dataset."
@@ -19787,14 +19975,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/965"
+ "$ref": "#/970"
},
"flags": 0,
"description": "SAP HANA Table properties."
},
"type": {
"type": {
- "$ref": "#/966"
+ "$ref": "#/971"
},
"flags": 1,
"description": "Type of dataset."
@@ -19831,14 +20019,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/968"
+ "$ref": "#/973"
},
"flags": 1,
"description": "SAP ODP Resource properties."
},
"type": {
"type": {
- "$ref": "#/969"
+ "$ref": "#/974"
},
"flags": 1,
"description": "Type of dataset."
@@ -19875,14 +20063,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/971"
+ "$ref": "#/976"
},
"flags": 1,
"description": "Sap Business Warehouse Open Hub Destination Table properties."
},
"type": {
"type": {
- "$ref": "#/972"
+ "$ref": "#/977"
},
"flags": 1,
"description": "Type of dataset."
@@ -19926,14 +20114,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/974"
+ "$ref": "#/979"
},
"flags": 1,
"description": "SAP Table Resource properties."
},
"type": {
"type": {
- "$ref": "#/975"
+ "$ref": "#/980"
},
"flags": 1,
"description": "Type of dataset."
@@ -19963,14 +20151,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/977"
+ "$ref": "#/982"
},
"flags": 1,
"description": "Type of dataset."
@@ -19987,20 +20175,62 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/984"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/979"
+ "$ref": "#/988"
},
"flags": 1,
"description": "Type of dataset."
}
}
},
+ {
+ "$type": "ObjectType",
+ "name": "ServiceNowV2DatasetTypeProperties",
+ "properties": {
+ "tableName": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "The table name. Type: string (or Expression with resultType string)."
+ },
+ "valueType": {
+ "type": {
+ "$ref": "#/987"
+ },
+ "flags": 0,
+ "description": "Type of value copied from source."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "actual"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "display"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/985"
+ },
+ {
+ "$ref": "#/986"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
{
"$type": "StringLiteralType",
"value": "ServiceNowV2Object"
@@ -20011,14 +20241,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/981"
+ "$ref": "#/990"
},
"flags": 0,
"description": "Sharepoint online list dataset properties."
},
"type": {
"type": {
- "$ref": "#/982"
+ "$ref": "#/991"
},
"flags": 1,
"description": "Type of dataset."
@@ -20048,14 +20278,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/984"
+ "$ref": "#/993"
},
"flags": 1,
"description": "Type of dataset."
@@ -20072,14 +20302,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/986"
+ "$ref": "#/995"
},
"flags": 1,
"description": "Snowflake dataset properties."
},
"type": {
"type": {
- "$ref": "#/987"
+ "$ref": "#/996"
},
"flags": 1,
"description": "Type of dataset."
@@ -20116,14 +20346,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/986"
+ "$ref": "#/995"
},
"flags": 1,
"description": "Snowflake dataset properties."
},
"type": {
"type": {
- "$ref": "#/989"
+ "$ref": "#/998"
},
"flags": 1,
"description": "Type of dataset."
@@ -20140,14 +20370,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/991"
+ "$ref": "#/1000"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/992"
+ "$ref": "#/1001"
},
"flags": 1,
"description": "Type of dataset."
@@ -20191,14 +20421,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/994"
+ "$ref": "#/1003"
},
"flags": 0,
"description": "On-premises SQL Server dataset properties."
},
"type": {
"type": {
- "$ref": "#/995"
+ "$ref": "#/1004"
},
"flags": 1,
"description": "Type of dataset."
@@ -20242,14 +20472,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/997"
+ "$ref": "#/1006"
},
"flags": 1,
"description": "Type of dataset."
@@ -20266,14 +20496,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/999"
+ "$ref": "#/1008"
},
"flags": 0,
"description": "Sybase table dataset properties."
},
"type": {
"type": {
- "$ref": "#/1000"
+ "$ref": "#/1009"
},
"flags": 1,
"description": "Type of dataset."
@@ -20303,14 +20533,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1002"
+ "$ref": "#/1011"
},
"flags": 0,
"description": "Teradata dataset properties."
},
"type": {
"type": {
- "$ref": "#/1003"
+ "$ref": "#/1012"
},
"flags": 1,
"description": "Type of dataset."
@@ -20347,14 +20577,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1005"
+ "$ref": "#/1014"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/1006"
+ "$ref": "#/1015"
},
"flags": 1,
"description": "Type of dataset."
@@ -20398,14 +20628,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1008"
+ "$ref": "#/1017"
},
"flags": 0,
"description": "Microsoft Fabric Warehouse dataset properties."
},
"type": {
"type": {
- "$ref": "#/1009"
+ "$ref": "#/1018"
},
"flags": 1,
"description": "Type of dataset."
@@ -20442,14 +20672,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1011"
+ "$ref": "#/1020"
},
"flags": 1,
"description": "Web table dataset properties."
},
"type": {
"type": {
- "$ref": "#/1012"
+ "$ref": "#/1021"
},
"flags": 1,
"description": "Type of dataset."
@@ -20486,14 +20716,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/1014"
+ "$ref": "#/1023"
},
"flags": 1,
"description": "Type of dataset."
@@ -20510,14 +20740,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1016"
+ "$ref": "#/1025"
},
"flags": 0,
"description": "Xml dataset properties."
},
"type": {
"type": {
- "$ref": "#/1017"
+ "$ref": "#/1026"
},
"flags": 1,
"description": "Type of dataset."
@@ -20530,7 +20760,7 @@
"properties": {
"location": {
"type": {
- "$ref": "#/715"
+ "$ref": "#/720"
},
"flags": 1,
"description": "The location of the json data storage."
@@ -20551,7 +20781,7 @@
},
"compression": {
"type": {
- "$ref": "#/711"
+ "$ref": "#/716"
},
"flags": 0,
"description": "The data compression method used for the json dataset."
@@ -20568,14 +20798,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/687"
+ "$ref": "#/692"
},
"flags": 0,
"description": "Properties specific to this dataset type."
},
"type": {
"type": {
- "$ref": "#/1019"
+ "$ref": "#/1028"
},
"flags": 1,
"description": "Type of dataset."
@@ -20591,7 +20821,7 @@
"name": "Microsoft.DataFactory/factories/datasets@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/681"
+ "$ref": "#/686"
},
"flags": 0
},
@@ -20623,21 +20853,21 @@
},
"type": {
"type": {
- "$ref": "#/1021"
+ "$ref": "#/1030"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1022"
+ "$ref": "#/1031"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1024"
+ "$ref": "#/1033"
},
"flags": 1,
"description": "Properties of the pipeline."
@@ -20664,21 +20894,21 @@
},
"activities": {
"type": {
- "$ref": "#/1816"
+ "$ref": "#/1830"
},
"flags": 0,
"description": "List of activities in pipeline."
},
"parameters": {
"type": {
- "$ref": "#/1817"
+ "$ref": "#/1831"
},
"flags": 0,
"description": "List of parameters for pipeline."
},
"variables": {
"type": {
- "$ref": "#/1823"
+ "$ref": "#/1837"
},
"flags": 0,
"description": "List of variables for pipeline."
@@ -20692,28 +20922,28 @@
},
"annotations": {
"type": {
- "$ref": "#/1824"
+ "$ref": "#/1838"
},
"flags": 0,
"description": "List of tags that can be used for describing the Pipeline."
},
"runDimensions": {
"type": {
- "$ref": "#/1825"
+ "$ref": "#/1839"
},
"flags": 0,
"description": "Dimensions emitted by Pipeline."
},
"folder": {
"type": {
- "$ref": "#/1826"
+ "$ref": "#/1840"
},
"flags": 0,
"description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level."
},
"policy": {
"type": {
- "$ref": "#/1827"
+ "$ref": "#/1841"
},
"flags": 0,
"description": "Pipeline Policy."
@@ -20741,28 +20971,28 @@
},
"state": {
"type": {
- "$ref": "#/1028"
+ "$ref": "#/1037"
},
"flags": 0,
"description": "Activity state. This is an optional property and if not provided, the state will be Active by default."
},
"onInactiveMarkAs": {
"type": {
- "$ref": "#/1032"
+ "$ref": "#/1041"
},
"flags": 0,
"description": "Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default."
},
"dependsOn": {
"type": {
- "$ref": "#/1040"
+ "$ref": "#/1049"
},
"flags": 0,
"description": "Activity depends on condition."
},
"userProperties": {
"type": {
- "$ref": "#/1042"
+ "$ref": "#/1051"
},
"flags": 0,
"description": "Activity user properties."
@@ -20770,121 +21000,121 @@
},
"elements": {
"AppendVariable": {
- "$ref": "#/1043"
+ "$ref": "#/1052"
},
"AzureDataExplorerCommand": {
- "$ref": "#/1046"
+ "$ref": "#/1055"
},
"AzureFunctionActivity": {
- "$ref": "#/1051"
+ "$ref": "#/1060"
},
"AzureMLBatchExecution": {
- "$ref": "#/1063"
+ "$ref": "#/1072"
},
"AzureMLExecutePipeline": {
- "$ref": "#/1070"
+ "$ref": "#/1079"
},
"AzureMLUpdateResource": {
- "$ref": "#/1073"
+ "$ref": "#/1082"
},
"ExecutePipeline": {
- "$ref": "#/1076"
+ "$ref": "#/1085"
},
"Fail": {
- "$ref": "#/1084"
+ "$ref": "#/1093"
},
"Filter": {
- "$ref": "#/1087"
+ "$ref": "#/1096"
},
"ForEach": {
- "$ref": "#/1093"
+ "$ref": "#/1102"
},
"IfCondition": {
- "$ref": "#/1098"
+ "$ref": "#/1107"
},
"SetVariable": {
- "$ref": "#/1103"
+ "$ref": "#/1112"
},
"Switch": {
- "$ref": "#/1107"
+ "$ref": "#/1116"
},
"Until": {
- "$ref": "#/1114"
+ "$ref": "#/1123"
},
"Validation": {
- "$ref": "#/1118"
+ "$ref": "#/1127"
},
"Wait": {
- "$ref": "#/1125"
+ "$ref": "#/1134"
},
"WebHook": {
- "$ref": "#/1128"
+ "$ref": "#/1137"
},
"Copy": {
- "$ref": "#/1135"
+ "$ref": "#/1144"
},
"Custom": {
- "$ref": "#/1588"
+ "$ref": "#/1602"
},
"DataLakeAnalyticsU-SQL": {
- "$ref": "#/1595"
+ "$ref": "#/1609"
},
"DatabricksNotebook": {
- "$ref": "#/1599"
+ "$ref": "#/1613"
},
"DatabricksSparkJar": {
- "$ref": "#/1605"
+ "$ref": "#/1619"
},
"DatabricksSparkPython": {
- "$ref": "#/1611"
+ "$ref": "#/1625"
},
"Delete": {
- "$ref": "#/1617"
+ "$ref": "#/1631"
},
"ExecuteDataFlow": {
- "$ref": "#/1620"
+ "$ref": "#/1634"
},
"ExecuteSSISPackage": {
- "$ref": "#/1630"
+ "$ref": "#/1644"
},
"ExecuteWranglingDataflow": {
- "$ref": "#/1657"
+ "$ref": "#/1671"
},
"GetMetadata": {
- "$ref": "#/1665"
+ "$ref": "#/1679"
},
"HDInsightHive": {
- "$ref": "#/1680"
+ "$ref": "#/1694"
},
"HDInsightMapReduce": {
- "$ref": "#/1691"
+ "$ref": "#/1705"
},
"HDInsightPig": {
- "$ref": "#/1702"
+ "$ref": "#/1716"
},
"HDInsightSpark": {
- "$ref": "#/1711"
+ "$ref": "#/1725"
},
"HDInsightStreaming": {
- "$ref": "#/1720"
+ "$ref": "#/1734"
},
"Lookup": {
- "$ref": "#/1732"
+ "$ref": "#/1746"
},
"Script": {
- "$ref": "#/1735"
+ "$ref": "#/1749"
},
"SparkJob": {
- "$ref": "#/1763"
+ "$ref": "#/1777"
},
"SqlServerStoredProcedure": {
- "$ref": "#/1784"
+ "$ref": "#/1798"
},
"SynapseNotebook": {
- "$ref": "#/1787"
+ "$ref": "#/1801"
},
"WebActivity": {
- "$ref": "#/1805"
+ "$ref": "#/1819"
}
}
},
@@ -20900,10 +21130,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1026"
+ "$ref": "#/1035"
},
{
- "$ref": "#/1027"
+ "$ref": "#/1036"
},
{
"$ref": "#/2"
@@ -20926,13 +21156,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1029"
+ "$ref": "#/1038"
},
{
- "$ref": "#/1030"
+ "$ref": "#/1039"
},
{
- "$ref": "#/1031"
+ "$ref": "#/1040"
},
{
"$ref": "#/2"
@@ -20952,7 +21182,7 @@
},
"dependencyConditions": {
"type": {
- "$ref": "#/1039"
+ "$ref": "#/1048"
},
"flags": 1,
"description": "Match-Condition for the dependency."
@@ -20982,16 +21212,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1034"
+ "$ref": "#/1043"
},
{
- "$ref": "#/1035"
+ "$ref": "#/1044"
},
{
- "$ref": "#/1036"
+ "$ref": "#/1045"
},
{
- "$ref": "#/1037"
+ "$ref": "#/1046"
},
{
"$ref": "#/2"
@@ -21001,13 +21231,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1038"
+ "$ref": "#/1047"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1033"
+ "$ref": "#/1042"
}
},
{
@@ -21033,7 +21263,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1041"
+ "$ref": "#/1050"
}
},
{
@@ -21042,14 +21272,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1044"
+ "$ref": "#/1053"
},
"flags": 1,
"description": "Append Variable activity properties."
},
"type": {
"type": {
- "$ref": "#/1045"
+ "$ref": "#/1054"
},
"flags": 1,
"description": "Type of activity."
@@ -21086,7 +21316,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1047"
+ "$ref": "#/1056"
},
"flags": 1,
"description": "Azure Data Explorer command activity properties."
@@ -21100,14 +21330,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1050"
+ "$ref": "#/1059"
},
"flags": 1,
"description": "Type of activity."
@@ -21154,7 +21384,7 @@
},
"retryIntervalInSeconds": {
"type": {
- "$ref": "#/1049"
+ "$ref": "#/1058"
},
"flags": 0,
"description": "Interval between each retry attempt (in seconds). The default is 30 sec."
@@ -21193,7 +21423,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1052"
+ "$ref": "#/1061"
},
"flags": 1,
"description": "Azure Function activity properties."
@@ -21207,14 +21437,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1062"
+ "$ref": "#/1071"
},
"flags": 1,
"description": "Type of activity."
@@ -21227,7 +21457,7 @@
"properties": {
"method": {
"type": {
- "$ref": "#/1060"
+ "$ref": "#/1069"
},
"flags": 1,
"description": "Rest API method for target endpoint."
@@ -21241,7 +21471,7 @@
},
"headers": {
"type": {
- "$ref": "#/1061"
+ "$ref": "#/1070"
},
"flags": 0,
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)."
@@ -21287,25 +21517,25 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1053"
+ "$ref": "#/1062"
},
{
- "$ref": "#/1054"
+ "$ref": "#/1063"
},
{
- "$ref": "#/1055"
+ "$ref": "#/1064"
},
{
- "$ref": "#/1056"
+ "$ref": "#/1065"
},
{
- "$ref": "#/1057"
+ "$ref": "#/1066"
},
{
- "$ref": "#/1058"
+ "$ref": "#/1067"
},
{
- "$ref": "#/1059"
+ "$ref": "#/1068"
},
{
"$ref": "#/2"
@@ -21330,7 +21560,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1064"
+ "$ref": "#/1073"
},
"flags": 1,
"description": "Azure ML Batch Execution activity properties."
@@ -21344,14 +21574,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1069"
+ "$ref": "#/1078"
},
"flags": 1,
"description": "Type of activity."
@@ -21364,21 +21594,21 @@
"properties": {
"globalParameters": {
"type": {
- "$ref": "#/1065"
+ "$ref": "#/1074"
},
"flags": 0,
"description": "Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request."
},
"webServiceOutputs": {
"type": {
- "$ref": "#/1067"
+ "$ref": "#/1076"
},
"flags": 0,
"description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request."
},
"webServiceInputs": {
"type": {
- "$ref": "#/1068"
+ "$ref": "#/1077"
},
"flags": 0,
"description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request."
@@ -21418,7 +21648,7 @@
"name": "AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs",
"properties": {},
"additionalProperties": {
- "$ref": "#/1066"
+ "$ref": "#/1075"
}
},
{
@@ -21426,7 +21656,7 @@
"name": "AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs",
"properties": {},
"additionalProperties": {
- "$ref": "#/1066"
+ "$ref": "#/1075"
}
},
{
@@ -21439,7 +21669,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1071"
+ "$ref": "#/1080"
},
"flags": 1,
"description": "Azure ML Execute Pipeline activity properties."
@@ -21453,14 +21683,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1072"
+ "$ref": "#/1081"
},
"flags": 1,
"description": "Type of activity."
@@ -21539,7 +21769,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1074"
+ "$ref": "#/1083"
},
"flags": 1,
"description": "Azure ML Update Resource management activity properties."
@@ -21553,14 +21783,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1075"
+ "$ref": "#/1084"
},
"flags": 1,
"description": "Type of activity."
@@ -21604,21 +21834,21 @@
"properties": {
"policy": {
"type": {
- "$ref": "#/1077"
+ "$ref": "#/1086"
},
"flags": 0,
"description": "Execute pipeline activity policy."
},
"typeProperties": {
"type": {
- "$ref": "#/1078"
+ "$ref": "#/1087"
},
"flags": 1,
"description": "Execute pipeline activity properties."
},
"type": {
"type": {
- "$ref": "#/1083"
+ "$ref": "#/1092"
},
"flags": 1,
"description": "Type of activity."
@@ -21647,14 +21877,14 @@
"properties": {
"pipeline": {
"type": {
- "$ref": "#/1079"
+ "$ref": "#/1088"
},
"flags": 1,
"description": "Pipeline reference."
},
"parameters": {
"type": {
- "$ref": "#/1082"
+ "$ref": "#/1091"
},
"flags": 0,
"description": "Pipeline parameters."
@@ -21674,7 +21904,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1081"
+ "$ref": "#/1090"
},
"flags": 1,
"description": "Pipeline reference type."
@@ -21703,7 +21933,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1080"
+ "$ref": "#/1089"
},
{
"$ref": "#/2"
@@ -21728,14 +21958,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1085"
+ "$ref": "#/1094"
},
"flags": 1,
"description": "Fail activity properties."
},
"type": {
"type": {
- "$ref": "#/1086"
+ "$ref": "#/1095"
},
"flags": 1,
"description": "Type of activity."
@@ -21772,14 +22002,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1088"
+ "$ref": "#/1097"
},
"flags": 1,
"description": "Filter activity properties."
},
"type": {
"type": {
- "$ref": "#/1092"
+ "$ref": "#/1101"
},
"flags": 1,
"description": "Type of activity."
@@ -21792,14 +22022,14 @@
"properties": {
"items": {
"type": {
- "$ref": "#/1089"
+ "$ref": "#/1098"
},
"flags": 1,
"description": "Input array on which filter should be applied."
},
"condition": {
"type": {
- "$ref": "#/1089"
+ "$ref": "#/1098"
},
"flags": 1,
"description": "Condition to be used for filtering the input."
@@ -21812,7 +22042,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1091"
+ "$ref": "#/1100"
},
"flags": 1,
"description": "Expression type."
@@ -21834,7 +22064,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1090"
+ "$ref": "#/1099"
},
{
"$ref": "#/2"
@@ -21851,14 +22081,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1094"
+ "$ref": "#/1103"
},
"flags": 1,
"description": "ForEach activity properties."
},
"type": {
"type": {
- "$ref": "#/1097"
+ "$ref": "#/1106"
},
"flags": 1,
"description": "Type of activity."
@@ -21878,21 +22108,21 @@
},
"batchCount": {
"type": {
- "$ref": "#/1095"
+ "$ref": "#/1104"
},
"flags": 0,
"description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false)."
},
"items": {
"type": {
- "$ref": "#/1089"
+ "$ref": "#/1098"
},
"flags": 1,
"description": "Collection to iterate."
},
"activities": {
"type": {
- "$ref": "#/1096"
+ "$ref": "#/1105"
},
"flags": 1,
"description": "List of activities to execute ."
@@ -21906,7 +22136,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
@@ -21919,14 +22149,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1099"
+ "$ref": "#/1108"
},
"flags": 1,
"description": "IfCondition activity properties."
},
"type": {
"type": {
- "$ref": "#/1102"
+ "$ref": "#/1111"
},
"flags": 1,
"description": "Type of activity."
@@ -21939,21 +22169,21 @@
"properties": {
"expression": {
"type": {
- "$ref": "#/1089"
+ "$ref": "#/1098"
},
"flags": 1,
"description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed."
},
"ifTrueActivities": {
"type": {
- "$ref": "#/1100"
+ "$ref": "#/1109"
},
"flags": 0,
"description": "List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action."
},
"ifFalseActivities": {
"type": {
- "$ref": "#/1101"
+ "$ref": "#/1110"
},
"flags": 0,
"description": "List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action."
@@ -21963,13 +22193,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
@@ -21982,21 +22212,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1104"
+ "$ref": "#/1113"
},
"flags": 1,
"description": "Set Variable activity properties."
},
"policy": {
"type": {
- "$ref": "#/1105"
+ "$ref": "#/1114"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1106"
+ "$ref": "#/1115"
},
"flags": 1,
"description": "Type of activity."
@@ -22060,14 +22290,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1108"
+ "$ref": "#/1117"
},
"flags": 1,
"description": "Switch activity properties."
},
"type": {
"type": {
- "$ref": "#/1113"
+ "$ref": "#/1122"
},
"flags": 1,
"description": "Type of activity."
@@ -22080,21 +22310,21 @@
"properties": {
"on": {
"type": {
- "$ref": "#/1089"
+ "$ref": "#/1098"
},
"flags": 1,
"description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed."
},
"cases": {
"type": {
- "$ref": "#/1111"
+ "$ref": "#/1120"
},
"flags": 0,
"description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities."
},
"defaultActivities": {
"type": {
- "$ref": "#/1112"
+ "$ref": "#/1121"
},
"flags": 0,
"description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action."
@@ -22114,7 +22344,7 @@
},
"activities": {
"type": {
- "$ref": "#/1110"
+ "$ref": "#/1119"
},
"flags": 0,
"description": "List of activities to execute for satisfied case condition."
@@ -22124,19 +22354,19 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1109"
+ "$ref": "#/1118"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
@@ -22149,14 +22379,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1115"
+ "$ref": "#/1124"
},
"flags": 1,
"description": "Until activity properties."
},
"type": {
"type": {
- "$ref": "#/1117"
+ "$ref": "#/1126"
},
"flags": 1,
"description": "Type of activity."
@@ -22169,7 +22399,7 @@
"properties": {
"expression": {
"type": {
- "$ref": "#/1089"
+ "$ref": "#/1098"
},
"flags": 1,
"description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true"
@@ -22183,7 +22413,7 @@
},
"activities": {
"type": {
- "$ref": "#/1116"
+ "$ref": "#/1125"
},
"flags": 1,
"description": "List of activities to execute."
@@ -22193,7 +22423,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
@@ -22206,14 +22436,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1119"
+ "$ref": "#/1128"
},
"flags": 1,
"description": "Validation activity properties."
},
"type": {
"type": {
- "$ref": "#/1124"
+ "$ref": "#/1133"
},
"flags": 1,
"description": "Type of activity."
@@ -22254,7 +22484,7 @@
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 1,
"description": "Validation activity dataset reference."
@@ -22267,7 +22497,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1122"
+ "$ref": "#/1131"
},
"flags": 1,
"description": "Dataset reference type."
@@ -22281,7 +22511,7 @@
},
"parameters": {
"type": {
- "$ref": "#/1123"
+ "$ref": "#/1132"
},
"flags": 0,
"description": "Arguments for dataset."
@@ -22296,7 +22526,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1121"
+ "$ref": "#/1130"
},
{
"$ref": "#/2"
@@ -22321,14 +22551,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1126"
+ "$ref": "#/1135"
},
"flags": 1,
"description": "Wait activity properties."
},
"type": {
"type": {
- "$ref": "#/1127"
+ "$ref": "#/1136"
},
"flags": 1,
"description": "Type of activity."
@@ -22358,21 +22588,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1129"
+ "$ref": "#/1138"
},
"flags": 1,
"description": "WebHook activity properties."
},
"policy": {
"type": {
- "$ref": "#/1105"
+ "$ref": "#/1114"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1134"
+ "$ref": "#/1143"
},
"flags": 1,
"description": "Type of activity."
@@ -22385,7 +22615,7 @@
"properties": {
"method": {
"type": {
- "$ref": "#/1131"
+ "$ref": "#/1140"
},
"flags": 1,
"description": "Rest API method for target endpoint."
@@ -22406,7 +22636,7 @@
},
"headers": {
"type": {
- "$ref": "#/1132"
+ "$ref": "#/1141"
},
"flags": 0,
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)."
@@ -22420,7 +22650,7 @@
},
"authentication": {
"type": {
- "$ref": "#/1133"
+ "$ref": "#/1142"
},
"flags": 0,
"description": "Authentication method used for calling the endpoint."
@@ -22442,7 +22672,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1130"
+ "$ref": "#/1139"
},
{
"$ref": "#/2"
@@ -22522,21 +22752,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1136"
+ "$ref": "#/1145"
},
"flags": 1,
"description": "Copy activity properties."
},
"inputs": {
"type": {
- "$ref": "#/1585"
+ "$ref": "#/1599"
},
"flags": 0,
"description": "List of inputs for the activity."
},
"outputs": {
"type": {
- "$ref": "#/1586"
+ "$ref": "#/1600"
},
"flags": 0,
"description": "List of outputs for the activity."
@@ -22550,14 +22780,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1587"
+ "$ref": "#/1601"
},
"flags": 1,
"description": "Type of activity."
@@ -22570,14 +22800,14 @@
"properties": {
"source": {
"type": {
- "$ref": "#/1137"
+ "$ref": "#/1146"
},
"flags": 1,
"description": "Copy activity source."
},
"sink": {
"type": {
- "$ref": "#/1419"
+ "$ref": "#/1428"
},
"flags": 1,
"description": "Copy activity sink."
@@ -22598,7 +22828,7 @@
},
"stagingSettings": {
"type": {
- "$ref": "#/1576"
+ "$ref": "#/1590"
},
"flags": 0,
"description": "Specifies interim staging settings when EnableStaging is true."
@@ -22626,35 +22856,35 @@
},
"redirectIncompatibleRowSettings": {
"type": {
- "$ref": "#/1577"
+ "$ref": "#/1591"
},
"flags": 0,
"description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true."
},
"logStorageSettings": {
"type": {
- "$ref": "#/1578"
+ "$ref": "#/1592"
},
"flags": 0,
"description": "(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log."
},
"logSettings": {
"type": {
- "$ref": "#/1579"
+ "$ref": "#/1593"
},
"flags": 0,
"description": "Log settings customer needs provide when enabling log."
},
"preserveRules": {
"type": {
- "$ref": "#/1582"
+ "$ref": "#/1596"
},
"flags": 0,
"description": "Preserve Rules."
},
"preserve": {
"type": {
- "$ref": "#/1583"
+ "$ref": "#/1597"
},
"flags": 0,
"description": "Preserve rules."
@@ -22668,7 +22898,7 @@
},
"skipErrorFile": {
"type": {
- "$ref": "#/1584"
+ "$ref": "#/1598"
},
"flags": 0,
"description": "Specify the fault tolerance for data consistency."
@@ -22711,313 +22941,313 @@
},
"elements": {
"AmazonMWSSource": {
- "$ref": "#/1138"
+ "$ref": "#/1147"
},
"AmazonRdsForOracleSource": {
- "$ref": "#/1140"
+ "$ref": "#/1149"
},
"AmazonRdsForSqlServerSource": {
- "$ref": "#/1143"
+ "$ref": "#/1152"
},
"AmazonRedshiftSource": {
- "$ref": "#/1146"
+ "$ref": "#/1155"
},
"AvroSource": {
- "$ref": "#/1149"
+ "$ref": "#/1158"
},
"AzureBlobFSSource": {
- "$ref": "#/1181"
+ "$ref": "#/1190"
},
"AzureDataExplorerSource": {
- "$ref": "#/1183"
+ "$ref": "#/1192"
},
"AzureDataLakeStoreSource": {
- "$ref": "#/1185"
+ "$ref": "#/1194"
},
"AzureDatabricksDeltaLakeSource": {
- "$ref": "#/1187"
+ "$ref": "#/1196"
},
"AzureMariaDBSource": {
- "$ref": "#/1190"
+ "$ref": "#/1199"
},
"AzureMySqlSource": {
- "$ref": "#/1192"
+ "$ref": "#/1201"
},
"AzurePostgreSqlSource": {
- "$ref": "#/1194"
+ "$ref": "#/1203"
},
"AzureSqlSource": {
- "$ref": "#/1196"
+ "$ref": "#/1205"
},
"AzureTableSource": {
- "$ref": "#/1198"
+ "$ref": "#/1207"
},
"BinarySource": {
- "$ref": "#/1200"
+ "$ref": "#/1209"
},
"BlobSource": {
- "$ref": "#/1210"
+ "$ref": "#/1219"
},
"CassandraSource": {
- "$ref": "#/1212"
+ "$ref": "#/1221"
},
"CommonDataServiceForAppsSource": {
- "$ref": "#/1225"
+ "$ref": "#/1234"
},
"ConcurSource": {
- "$ref": "#/1227"
+ "$ref": "#/1236"
},
"CosmosDbMongoDbApiSource": {
- "$ref": "#/1229"
+ "$ref": "#/1238"
},
"CosmosDbSqlApiSource": {
- "$ref": "#/1232"
+ "$ref": "#/1241"
},
"CouchbaseSource": {
- "$ref": "#/1234"
+ "$ref": "#/1243"
},
"Db2Source": {
- "$ref": "#/1236"
+ "$ref": "#/1245"
},
"DelimitedTextSource": {
- "$ref": "#/1238"
+ "$ref": "#/1247"
},
"DocumentDbCollectionSource": {
- "$ref": "#/1241"
+ "$ref": "#/1250"
},
"DrillSource": {
- "$ref": "#/1243"
+ "$ref": "#/1252"
},
"DynamicsAXSource": {
- "$ref": "#/1245"
+ "$ref": "#/1254"
},
"DynamicsCrmSource": {
- "$ref": "#/1247"
+ "$ref": "#/1256"
},
"DynamicsSource": {
- "$ref": "#/1249"
+ "$ref": "#/1258"
},
"EloquaSource": {
- "$ref": "#/1251"
+ "$ref": "#/1260"
},
"ExcelSource": {
- "$ref": "#/1253"
+ "$ref": "#/1262"
},
"FileSystemSource": {
- "$ref": "#/1255"
+ "$ref": "#/1264"
},
"GoogleAdWordsSource": {
- "$ref": "#/1257"
+ "$ref": "#/1266"
},
"GoogleBigQuerySource": {
- "$ref": "#/1259"
+ "$ref": "#/1268"
},
"GoogleBigQueryV2Source": {
- "$ref": "#/1261"
+ "$ref": "#/1270"
},
"GreenplumSource": {
- "$ref": "#/1263"
+ "$ref": "#/1272"
},
"HBaseSource": {
- "$ref": "#/1265"
+ "$ref": "#/1274"
},
"HdfsSource": {
- "$ref": "#/1267"
+ "$ref": "#/1276"
},
"HiveSource": {
- "$ref": "#/1269"
+ "$ref": "#/1278"
},
"HttpSource": {
- "$ref": "#/1271"
+ "$ref": "#/1280"
},
"HubspotSource": {
- "$ref": "#/1273"
+ "$ref": "#/1282"
},
"ImpalaSource": {
- "$ref": "#/1275"
+ "$ref": "#/1284"
},
"InformixSource": {
- "$ref": "#/1277"
+ "$ref": "#/1286"
},
"JiraSource": {
- "$ref": "#/1279"
+ "$ref": "#/1288"
},
"JsonSource": {
- "$ref": "#/1281"
+ "$ref": "#/1290"
},
"LakeHouseTableSource": {
- "$ref": "#/1284"
+ "$ref": "#/1293"
},
"MagentoSource": {
- "$ref": "#/1286"
+ "$ref": "#/1295"
},
"MariaDBSource": {
- "$ref": "#/1288"
+ "$ref": "#/1297"
},
"MarketoSource": {
- "$ref": "#/1290"
+ "$ref": "#/1299"
},
"MicrosoftAccessSource": {
- "$ref": "#/1292"
+ "$ref": "#/1301"
},
"MongoDbAtlasSource": {
- "$ref": "#/1294"
+ "$ref": "#/1303"
},
"MongoDbSource": {
- "$ref": "#/1296"
+ "$ref": "#/1305"
},
"MongoDbV2Source": {
- "$ref": "#/1298"
+ "$ref": "#/1307"
},
"MySqlSource": {
- "$ref": "#/1300"
+ "$ref": "#/1309"
},
"NetezzaSource": {
- "$ref": "#/1302"
+ "$ref": "#/1311"
},
"ODataSource": {
- "$ref": "#/1305"
+ "$ref": "#/1314"
},
"OdbcSource": {
- "$ref": "#/1307"
+ "$ref": "#/1316"
},
"Office365Source": {
- "$ref": "#/1309"
+ "$ref": "#/1318"
},
"OracleServiceCloudSource": {
- "$ref": "#/1311"
+ "$ref": "#/1320"
},
"OracleSource": {
- "$ref": "#/1313"
+ "$ref": "#/1322"
},
"OrcSource": {
- "$ref": "#/1316"
+ "$ref": "#/1325"
},
"ParquetSource": {
- "$ref": "#/1318"
+ "$ref": "#/1327"
},
"PaypalSource": {
- "$ref": "#/1321"
+ "$ref": "#/1330"
},
"PhoenixSource": {
- "$ref": "#/1323"
+ "$ref": "#/1332"
},
"PostgreSqlSource": {
- "$ref": "#/1325"
+ "$ref": "#/1334"
},
"PostgreSqlV2Source": {
- "$ref": "#/1327"
+ "$ref": "#/1336"
},
"PrestoSource": {
- "$ref": "#/1329"
+ "$ref": "#/1338"
},
"QuickBooksSource": {
- "$ref": "#/1331"
+ "$ref": "#/1340"
},
"RelationalSource": {
- "$ref": "#/1333"
+ "$ref": "#/1342"
},
"ResponsysSource": {
- "$ref": "#/1335"
+ "$ref": "#/1344"
},
"RestSource": {
- "$ref": "#/1337"
+ "$ref": "#/1346"
},
"SalesforceMarketingCloudSource": {
- "$ref": "#/1339"
+ "$ref": "#/1348"
},
"SalesforceServiceCloudSource": {
- "$ref": "#/1341"
+ "$ref": "#/1350"
},
"SalesforceServiceCloudV2Source": {
- "$ref": "#/1343"
+ "$ref": "#/1352"
},
"SalesforceSource": {
- "$ref": "#/1345"
+ "$ref": "#/1354"
},
"SalesforceV2Source": {
- "$ref": "#/1347"
+ "$ref": "#/1356"
},
"SapBwSource": {
- "$ref": "#/1349"
+ "$ref": "#/1358"
},
"SapCloudForCustomerSource": {
- "$ref": "#/1351"
+ "$ref": "#/1360"
},
"SapEccSource": {
- "$ref": "#/1353"
+ "$ref": "#/1362"
},
"SapHanaSource": {
- "$ref": "#/1355"
+ "$ref": "#/1364"
},
"SapOdpSource": {
- "$ref": "#/1358"
+ "$ref": "#/1367"
},
"SapOpenHubSource": {
- "$ref": "#/1360"
+ "$ref": "#/1369"
},
"SapTableSource": {
- "$ref": "#/1362"
+ "$ref": "#/1371"
},
"ServiceNowSource": {
- "$ref": "#/1365"
+ "$ref": "#/1374"
},
"ServiceNowV2Source": {
- "$ref": "#/1367"
+ "$ref": "#/1376"
},
"SharePointOnlineListSource": {
- "$ref": "#/1378"
+ "$ref": "#/1387"
},
"ShopifySource": {
- "$ref": "#/1380"
+ "$ref": "#/1389"
},
"SnowflakeSource": {
- "$ref": "#/1382"
+ "$ref": "#/1391"
},
"SnowflakeV2Source": {
- "$ref": "#/1387"
+ "$ref": "#/1396"
},
"SparkSource": {
- "$ref": "#/1389"
+ "$ref": "#/1398"
},
"SqlDWSource": {
- "$ref": "#/1391"
+ "$ref": "#/1400"
},
"SqlMISource": {
- "$ref": "#/1393"
+ "$ref": "#/1402"
},
"SqlServerSource": {
- "$ref": "#/1395"
+ "$ref": "#/1404"
},
"SqlSource": {
- "$ref": "#/1397"
+ "$ref": "#/1406"
},
"SquareSource": {
- "$ref": "#/1399"
+ "$ref": "#/1408"
},
"SybaseSource": {
- "$ref": "#/1401"
+ "$ref": "#/1410"
},
"TeradataSource": {
- "$ref": "#/1403"
+ "$ref": "#/1412"
},
"VerticaSource": {
- "$ref": "#/1406"
+ "$ref": "#/1415"
},
"WarehouseSource": {
- "$ref": "#/1408"
+ "$ref": "#/1417"
},
"XeroSource": {
- "$ref": "#/1410"
+ "$ref": "#/1419"
},
"ZohoSource": {
- "$ref": "#/1412"
+ "$ref": "#/1421"
},
"WebSource": {
- "$ref": "#/1414"
+ "$ref": "#/1423"
},
"XmlSource": {
- "$ref": "#/1416"
+ "$ref": "#/1425"
}
}
},
@@ -23048,7 +23278,7 @@
},
"type": {
"type": {
- "$ref": "#/1139"
+ "$ref": "#/1148"
},
"flags": 1,
"description": "Copy source type."
@@ -23086,7 +23316,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1141"
+ "$ref": "#/1150"
},
"flags": 0,
"description": "The settings that will be leveraged for AmazonRdsForOracle source partitioning."
@@ -23100,7 +23330,7 @@
},
"type": {
"type": {
- "$ref": "#/1142"
+ "$ref": "#/1151"
},
"flags": 1,
"description": "Copy source type."
@@ -23193,7 +23423,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -23214,7 +23444,7 @@
},
"type": {
"type": {
- "$ref": "#/1145"
+ "$ref": "#/1154"
},
"flags": 1,
"description": "Copy source type."
@@ -23265,7 +23495,7 @@
},
"redshiftUnloadSettings": {
"type": {
- "$ref": "#/1147"
+ "$ref": "#/1156"
},
"flags": 0,
"description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3."
@@ -23286,7 +23516,7 @@
},
"type": {
"type": {
- "$ref": "#/1148"
+ "$ref": "#/1157"
},
"flags": 1,
"description": "Copy source type."
@@ -23323,7 +23553,7 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Avro store settings."
@@ -23337,7 +23567,7 @@
},
"type": {
"type": {
- "$ref": "#/1180"
+ "$ref": "#/1189"
},
"flags": 1,
"description": "Copy source type."
@@ -23366,46 +23596,46 @@
},
"elements": {
"AmazonS3CompatibleReadSettings": {
- "$ref": "#/1151"
+ "$ref": "#/1160"
},
"AmazonS3ReadSettings": {
- "$ref": "#/1153"
+ "$ref": "#/1162"
},
"AzureBlobFSReadSettings": {
- "$ref": "#/1155"
+ "$ref": "#/1164"
},
"AzureBlobStorageReadSettings": {
- "$ref": "#/1157"
+ "$ref": "#/1166"
},
"AzureDataLakeStoreReadSettings": {
- "$ref": "#/1159"
+ "$ref": "#/1168"
},
"AzureFileStorageReadSettings": {
- "$ref": "#/1161"
+ "$ref": "#/1170"
},
"FileServerReadSettings": {
- "$ref": "#/1163"
+ "$ref": "#/1172"
},
"FtpReadSettings": {
- "$ref": "#/1165"
+ "$ref": "#/1174"
},
"GoogleCloudStorageReadSettings": {
- "$ref": "#/1167"
+ "$ref": "#/1176"
},
"HdfsReadSettings": {
- "$ref": "#/1169"
+ "$ref": "#/1178"
},
"HttpReadSettings": {
- "$ref": "#/1172"
+ "$ref": "#/1181"
},
"LakeHouseReadSettings": {
- "$ref": "#/1174"
+ "$ref": "#/1183"
},
"OracleCloudStorageReadSettings": {
- "$ref": "#/1176"
+ "$ref": "#/1185"
},
"SftpReadSettings": {
- "$ref": "#/1178"
+ "$ref": "#/1187"
}
}
},
@@ -23485,7 +23715,7 @@
},
"type": {
"type": {
- "$ref": "#/1152"
+ "$ref": "#/1161"
},
"flags": 1,
"description": "The read setting type."
@@ -23572,7 +23802,7 @@
},
"type": {
"type": {
- "$ref": "#/1154"
+ "$ref": "#/1163"
},
"flags": 1,
"description": "The read setting type."
@@ -23652,7 +23882,7 @@
},
"type": {
"type": {
- "$ref": "#/1156"
+ "$ref": "#/1165"
},
"flags": 1,
"description": "The read setting type."
@@ -23739,7 +23969,7 @@
},
"type": {
"type": {
- "$ref": "#/1158"
+ "$ref": "#/1167"
},
"flags": 1,
"description": "The read setting type."
@@ -23833,7 +24063,7 @@
},
"type": {
"type": {
- "$ref": "#/1160"
+ "$ref": "#/1169"
},
"flags": 1,
"description": "The read setting type."
@@ -23920,7 +24150,7 @@
},
"type": {
"type": {
- "$ref": "#/1162"
+ "$ref": "#/1171"
},
"flags": 1,
"description": "The read setting type."
@@ -24007,7 +24237,7 @@
},
"type": {
"type": {
- "$ref": "#/1164"
+ "$ref": "#/1173"
},
"flags": 1,
"description": "The read setting type."
@@ -24087,7 +24317,7 @@
},
"type": {
"type": {
- "$ref": "#/1166"
+ "$ref": "#/1175"
},
"flags": 1,
"description": "The read setting type."
@@ -24174,7 +24404,7 @@
},
"type": {
"type": {
- "$ref": "#/1168"
+ "$ref": "#/1177"
},
"flags": 1,
"description": "The read setting type."
@@ -24247,7 +24477,7 @@
},
"distcpSettings": {
"type": {
- "$ref": "#/1170"
+ "$ref": "#/1179"
},
"flags": 0,
"description": "Specifies Distcp-related settings."
@@ -24261,7 +24491,7 @@
},
"type": {
"type": {
- "$ref": "#/1171"
+ "$ref": "#/1180"
},
"flags": 1,
"description": "The read setting type."
@@ -24340,7 +24570,7 @@
},
"type": {
"type": {
- "$ref": "#/1173"
+ "$ref": "#/1182"
},
"flags": 1,
"description": "The read setting type."
@@ -24420,7 +24650,7 @@
},
"type": {
"type": {
- "$ref": "#/1175"
+ "$ref": "#/1184"
},
"flags": 1,
"description": "The read setting type."
@@ -24507,7 +24737,7 @@
},
"type": {
"type": {
- "$ref": "#/1177"
+ "$ref": "#/1186"
},
"flags": 1,
"description": "The read setting type."
@@ -24594,7 +24824,7 @@
},
"type": {
"type": {
- "$ref": "#/1179"
+ "$ref": "#/1188"
},
"flags": 1,
"description": "The read setting type."
@@ -24636,7 +24866,7 @@
},
"type": {
"type": {
- "$ref": "#/1182"
+ "$ref": "#/1191"
},
"flags": 1,
"description": "Copy source type."
@@ -24681,7 +24911,7 @@
},
"type": {
"type": {
- "$ref": "#/1184"
+ "$ref": "#/1193"
},
"flags": 1,
"description": "Copy source type."
@@ -24705,7 +24935,7 @@
},
"type": {
"type": {
- "$ref": "#/1186"
+ "$ref": "#/1195"
},
"flags": 1,
"description": "Copy source type."
@@ -24729,14 +24959,14 @@
},
"exportSettings": {
"type": {
- "$ref": "#/1188"
+ "$ref": "#/1197"
},
"flags": 0,
"description": "Azure Databricks Delta Lake export settings."
},
"type": {
"type": {
- "$ref": "#/1189"
+ "$ref": "#/1198"
},
"flags": 1,
"description": "Copy source type."
@@ -24804,7 +25034,7 @@
},
"type": {
"type": {
- "$ref": "#/1191"
+ "$ref": "#/1200"
},
"flags": 1,
"description": "Copy source type."
@@ -24842,7 +25072,7 @@
},
"type": {
"type": {
- "$ref": "#/1193"
+ "$ref": "#/1202"
},
"flags": 1,
"description": "Copy source type."
@@ -24880,7 +25110,7 @@
},
"type": {
"type": {
- "$ref": "#/1195"
+ "$ref": "#/1204"
},
"flags": 1,
"description": "Copy source type."
@@ -24939,7 +25169,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -24960,7 +25190,7 @@
},
"type": {
"type": {
- "$ref": "#/1197"
+ "$ref": "#/1206"
},
"flags": 1,
"description": "Copy source type."
@@ -25005,7 +25235,7 @@
},
"type": {
"type": {
- "$ref": "#/1199"
+ "$ref": "#/1208"
},
"flags": 1,
"description": "Copy source type."
@@ -25022,21 +25252,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Binary store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1201"
+ "$ref": "#/1210"
},
"flags": 0,
"description": "Binary format settings."
},
"type": {
"type": {
- "$ref": "#/1209"
+ "$ref": "#/1218"
},
"flags": 1,
"description": "Copy source type."
@@ -25049,7 +25279,7 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
@@ -25073,13 +25303,13 @@
"baseProperties": {},
"elements": {
"TarGZipReadSettings": {
- "$ref": "#/1203"
+ "$ref": "#/1212"
},
"TarReadSettings": {
- "$ref": "#/1205"
+ "$ref": "#/1214"
},
"ZipDeflateReadSettings": {
- "$ref": "#/1207"
+ "$ref": "#/1216"
}
}
},
@@ -25096,7 +25326,7 @@
},
"type": {
"type": {
- "$ref": "#/1204"
+ "$ref": "#/1213"
},
"flags": 1,
"description": "The Compression setting type."
@@ -25120,7 +25350,7 @@
},
"type": {
"type": {
- "$ref": "#/1206"
+ "$ref": "#/1215"
},
"flags": 1,
"description": "The Compression setting type."
@@ -25144,7 +25374,7 @@
},
"type": {
"type": {
- "$ref": "#/1208"
+ "$ref": "#/1217"
},
"flags": 1,
"description": "The Compression setting type."
@@ -25186,7 +25416,7 @@
},
"type": {
"type": {
- "$ref": "#/1211"
+ "$ref": "#/1220"
},
"flags": 1,
"description": "Copy source type."
@@ -25210,7 +25440,7 @@
},
"consistencyLevel": {
"type": {
- "$ref": "#/1223"
+ "$ref": "#/1232"
},
"flags": 0,
"description": "The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive."
@@ -25231,7 +25461,7 @@
},
"type": {
"type": {
- "$ref": "#/1224"
+ "$ref": "#/1233"
},
"flags": 1,
"description": "Copy source type."
@@ -25282,34 +25512,34 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1213"
+ "$ref": "#/1222"
},
{
- "$ref": "#/1214"
+ "$ref": "#/1223"
},
{
- "$ref": "#/1215"
+ "$ref": "#/1224"
},
{
- "$ref": "#/1216"
+ "$ref": "#/1225"
},
{
- "$ref": "#/1217"
+ "$ref": "#/1226"
},
{
- "$ref": "#/1218"
+ "$ref": "#/1227"
},
{
- "$ref": "#/1219"
+ "$ref": "#/1228"
},
{
- "$ref": "#/1220"
+ "$ref": "#/1229"
},
{
- "$ref": "#/1221"
+ "$ref": "#/1230"
},
{
- "$ref": "#/1222"
+ "$ref": "#/1231"
},
{
"$ref": "#/2"
@@ -25340,7 +25570,7 @@
},
"type": {
"type": {
- "$ref": "#/1226"
+ "$ref": "#/1235"
},
"flags": 1,
"description": "Copy source type."
@@ -25378,7 +25608,7 @@
},
"type": {
"type": {
- "$ref": "#/1228"
+ "$ref": "#/1237"
},
"flags": 1,
"description": "Copy source type."
@@ -25402,7 +25632,7 @@
},
"cursorMethods": {
"type": {
- "$ref": "#/1230"
+ "$ref": "#/1239"
},
"flags": 0,
"description": "Cursor methods for Mongodb query."
@@ -25430,7 +25660,7 @@
},
"type": {
"type": {
- "$ref": "#/1231"
+ "$ref": "#/1240"
},
"flags": 1,
"description": "Copy source type."
@@ -25519,7 +25749,7 @@
},
"type": {
"type": {
- "$ref": "#/1233"
+ "$ref": "#/1242"
},
"flags": 1,
"description": "Copy source type."
@@ -25557,7 +25787,7 @@
},
"type": {
"type": {
- "$ref": "#/1235"
+ "$ref": "#/1244"
},
"flags": 1,
"description": "Copy source type."
@@ -25595,7 +25825,7 @@
},
"type": {
"type": {
- "$ref": "#/1237"
+ "$ref": "#/1246"
},
"flags": 1,
"description": "Copy source type."
@@ -25612,14 +25842,14 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "DelimitedText store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1239"
+ "$ref": "#/1248"
},
"flags": 0,
"description": "DelimitedText format settings."
@@ -25633,7 +25863,7 @@
},
"type": {
"type": {
- "$ref": "#/1240"
+ "$ref": "#/1249"
},
"flags": 1,
"description": "Copy source type."
@@ -25653,7 +25883,7 @@
},
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
@@ -25708,7 +25938,7 @@
},
"type": {
"type": {
- "$ref": "#/1242"
+ "$ref": "#/1251"
},
"flags": 1,
"description": "Copy source type."
@@ -25746,7 +25976,7 @@
},
"type": {
"type": {
- "$ref": "#/1244"
+ "$ref": "#/1253"
},
"flags": 1,
"description": "Copy source type."
@@ -25791,7 +26021,7 @@
},
"type": {
"type": {
- "$ref": "#/1246"
+ "$ref": "#/1255"
},
"flags": 1,
"description": "Copy source type."
@@ -25822,7 +26052,7 @@
},
"type": {
"type": {
- "$ref": "#/1248"
+ "$ref": "#/1257"
},
"flags": 1,
"description": "Copy source type."
@@ -25853,7 +26083,7 @@
},
"type": {
"type": {
- "$ref": "#/1250"
+ "$ref": "#/1259"
},
"flags": 1,
"description": "Copy source type."
@@ -25891,7 +26121,7 @@
},
"type": {
"type": {
- "$ref": "#/1252"
+ "$ref": "#/1261"
},
"flags": 1,
"description": "Copy source type."
@@ -25908,7 +26138,7 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Excel store settings."
@@ -25922,7 +26152,7 @@
},
"type": {
"type": {
- "$ref": "#/1254"
+ "$ref": "#/1263"
},
"flags": 1,
"description": "Copy source type."
@@ -25953,7 +26183,7 @@
},
"type": {
"type": {
- "$ref": "#/1256"
+ "$ref": "#/1265"
},
"flags": 1,
"description": "Copy source type."
@@ -25991,7 +26221,7 @@
},
"type": {
"type": {
- "$ref": "#/1258"
+ "$ref": "#/1267"
},
"flags": 1,
"description": "Copy source type."
@@ -26029,7 +26259,7 @@
},
"type": {
"type": {
- "$ref": "#/1260"
+ "$ref": "#/1269"
},
"flags": 1,
"description": "Copy source type."
@@ -26067,7 +26297,7 @@
},
"type": {
"type": {
- "$ref": "#/1262"
+ "$ref": "#/1271"
},
"flags": 1,
"description": "Copy source type."
@@ -26105,7 +26335,7 @@
},
"type": {
"type": {
- "$ref": "#/1264"
+ "$ref": "#/1273"
},
"flags": 1,
"description": "Copy source type."
@@ -26143,7 +26373,7 @@
},
"type": {
"type": {
- "$ref": "#/1266"
+ "$ref": "#/1275"
},
"flags": 1,
"description": "Copy source type."
@@ -26167,14 +26397,14 @@
},
"distcpSettings": {
"type": {
- "$ref": "#/1170"
+ "$ref": "#/1179"
},
"flags": 0,
"description": "Specifies Distcp-related settings."
},
"type": {
"type": {
- "$ref": "#/1268"
+ "$ref": "#/1277"
},
"flags": 1,
"description": "Copy source type."
@@ -26212,7 +26442,7 @@
},
"type": {
"type": {
- "$ref": "#/1270"
+ "$ref": "#/1279"
},
"flags": 1,
"description": "Copy source type."
@@ -26236,7 +26466,7 @@
},
"type": {
"type": {
- "$ref": "#/1272"
+ "$ref": "#/1281"
},
"flags": 1,
"description": "Copy source type."
@@ -26274,7 +26504,7 @@
},
"type": {
"type": {
- "$ref": "#/1274"
+ "$ref": "#/1283"
},
"flags": 1,
"description": "Copy source type."
@@ -26312,7 +26542,7 @@
},
"type": {
"type": {
- "$ref": "#/1276"
+ "$ref": "#/1285"
},
"flags": 1,
"description": "Copy source type."
@@ -26350,7 +26580,7 @@
},
"type": {
"type": {
- "$ref": "#/1278"
+ "$ref": "#/1287"
},
"flags": 1,
"description": "Copy source type."
@@ -26388,7 +26618,7 @@
},
"type": {
"type": {
- "$ref": "#/1280"
+ "$ref": "#/1289"
},
"flags": 1,
"description": "Copy source type."
@@ -26405,14 +26635,14 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Json store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1282"
+ "$ref": "#/1291"
},
"flags": 0,
"description": "Json format settings."
@@ -26426,7 +26656,7 @@
},
"type": {
"type": {
- "$ref": "#/1283"
+ "$ref": "#/1292"
},
"flags": 1,
"description": "Copy source type."
@@ -26439,7 +26669,7 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
@@ -26487,7 +26717,7 @@
},
"type": {
"type": {
- "$ref": "#/1285"
+ "$ref": "#/1294"
},
"flags": 1,
"description": "Copy source type."
@@ -26525,7 +26755,7 @@
},
"type": {
"type": {
- "$ref": "#/1287"
+ "$ref": "#/1296"
},
"flags": 1,
"description": "Copy source type."
@@ -26563,7 +26793,7 @@
},
"type": {
"type": {
- "$ref": "#/1289"
+ "$ref": "#/1298"
},
"flags": 1,
"description": "Copy source type."
@@ -26601,7 +26831,7 @@
},
"type": {
"type": {
- "$ref": "#/1291"
+ "$ref": "#/1300"
},
"flags": 1,
"description": "Copy source type."
@@ -26632,7 +26862,7 @@
},
"type": {
"type": {
- "$ref": "#/1293"
+ "$ref": "#/1302"
},
"flags": 1,
"description": "Copy source type."
@@ -26656,7 +26886,7 @@
},
"cursorMethods": {
"type": {
- "$ref": "#/1230"
+ "$ref": "#/1239"
},
"flags": 0,
"description": "Cursor methods for Mongodb query"
@@ -26684,7 +26914,7 @@
},
"type": {
"type": {
- "$ref": "#/1295"
+ "$ref": "#/1304"
},
"flags": 1,
"description": "Copy source type."
@@ -26715,7 +26945,7 @@
},
"type": {
"type": {
- "$ref": "#/1297"
+ "$ref": "#/1306"
},
"flags": 1,
"description": "Copy source type."
@@ -26739,7 +26969,7 @@
},
"cursorMethods": {
"type": {
- "$ref": "#/1230"
+ "$ref": "#/1239"
},
"flags": 0,
"description": "Cursor methods for Mongodb query"
@@ -26767,7 +26997,7 @@
},
"type": {
"type": {
- "$ref": "#/1299"
+ "$ref": "#/1308"
},
"flags": 1,
"description": "Copy source type."
@@ -26805,7 +27035,7 @@
},
"type": {
"type": {
- "$ref": "#/1301"
+ "$ref": "#/1310"
},
"flags": 1,
"description": "Copy source type."
@@ -26836,7 +27066,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1303"
+ "$ref": "#/1312"
},
"flags": 0,
"description": "The settings that will be leveraged for Netezza source partitioning."
@@ -26857,7 +27087,7 @@
},
"type": {
"type": {
- "$ref": "#/1304"
+ "$ref": "#/1313"
},
"flags": 1,
"description": "Copy source type."
@@ -26922,7 +27152,7 @@
},
"type": {
"type": {
- "$ref": "#/1306"
+ "$ref": "#/1315"
},
"flags": 1,
"description": "Copy source type."
@@ -26960,7 +27190,7 @@
},
"type": {
"type": {
- "$ref": "#/1308"
+ "$ref": "#/1317"
},
"flags": 1,
"description": "Copy source type."
@@ -27019,7 +27249,7 @@
},
"type": {
"type": {
- "$ref": "#/1310"
+ "$ref": "#/1319"
},
"flags": 1,
"description": "Copy source type."
@@ -27057,7 +27287,7 @@
},
"type": {
"type": {
- "$ref": "#/1312"
+ "$ref": "#/1321"
},
"flags": 1,
"description": "Copy source type."
@@ -27095,7 +27325,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1314"
+ "$ref": "#/1323"
},
"flags": 0,
"description": "The settings that will be leveraged for Oracle source partitioning."
@@ -27109,7 +27339,7 @@
},
"type": {
"type": {
- "$ref": "#/1315"
+ "$ref": "#/1324"
},
"flags": 1,
"description": "Copy source type."
@@ -27160,7 +27390,7 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "ORC store settings."
@@ -27174,7 +27404,7 @@
},
"type": {
"type": {
- "$ref": "#/1317"
+ "$ref": "#/1326"
},
"flags": 1,
"description": "Copy source type."
@@ -27191,14 +27421,14 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Parquet store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1319"
+ "$ref": "#/1328"
},
"flags": 0,
"description": "Parquet format settings."
@@ -27212,7 +27442,7 @@
},
"type": {
"type": {
- "$ref": "#/1320"
+ "$ref": "#/1329"
},
"flags": 1,
"description": "Copy source type."
@@ -27225,7 +27455,7 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
@@ -27273,7 +27503,7 @@
},
"type": {
"type": {
- "$ref": "#/1322"
+ "$ref": "#/1331"
},
"flags": 1,
"description": "Copy source type."
@@ -27311,7 +27541,7 @@
},
"type": {
"type": {
- "$ref": "#/1324"
+ "$ref": "#/1333"
},
"flags": 1,
"description": "Copy source type."
@@ -27349,7 +27579,7 @@
},
"type": {
"type": {
- "$ref": "#/1326"
+ "$ref": "#/1335"
},
"flags": 1,
"description": "Copy source type."
@@ -27387,7 +27617,7 @@
},
"type": {
"type": {
- "$ref": "#/1328"
+ "$ref": "#/1337"
},
"flags": 1,
"description": "Copy source type."
@@ -27425,7 +27655,7 @@
},
"type": {
"type": {
- "$ref": "#/1330"
+ "$ref": "#/1339"
},
"flags": 1,
"description": "Copy source type."
@@ -27463,7 +27693,7 @@
},
"type": {
"type": {
- "$ref": "#/1332"
+ "$ref": "#/1341"
},
"flags": 1,
"description": "Copy source type."
@@ -27494,7 +27724,7 @@
},
"type": {
"type": {
- "$ref": "#/1334"
+ "$ref": "#/1343"
},
"flags": 1,
"description": "Copy source type."
@@ -27532,7 +27762,7 @@
},
"type": {
"type": {
- "$ref": "#/1336"
+ "$ref": "#/1345"
},
"flags": 1,
"description": "Copy source type."
@@ -27598,7 +27828,7 @@
},
"type": {
"type": {
- "$ref": "#/1338"
+ "$ref": "#/1347"
},
"flags": 1,
"description": "Copy source type."
@@ -27636,7 +27866,7 @@
},
"type": {
"type": {
- "$ref": "#/1340"
+ "$ref": "#/1349"
},
"flags": 1,
"description": "Copy source type."
@@ -27674,7 +27904,7 @@
},
"type": {
"type": {
- "$ref": "#/1342"
+ "$ref": "#/1351"
},
"flags": 1,
"description": "Copy source type."
@@ -27719,7 +27949,7 @@
},
"type": {
"type": {
- "$ref": "#/1344"
+ "$ref": "#/1353"
},
"flags": 1,
"description": "Copy source type."
@@ -27764,7 +27994,7 @@
},
"type": {
"type": {
- "$ref": "#/1346"
+ "$ref": "#/1355"
},
"flags": 1,
"description": "Copy source type."
@@ -27823,7 +28053,7 @@
},
"type": {
"type": {
- "$ref": "#/1348"
+ "$ref": "#/1357"
},
"flags": 1,
"description": "Copy source type."
@@ -27861,7 +28091,7 @@
},
"type": {
"type": {
- "$ref": "#/1350"
+ "$ref": "#/1359"
},
"flags": 1,
"description": "Copy source type."
@@ -27906,7 +28136,7 @@
},
"type": {
"type": {
- "$ref": "#/1352"
+ "$ref": "#/1361"
},
"flags": 1,
"description": "Copy source type."
@@ -27951,7 +28181,7 @@
},
"type": {
"type": {
- "$ref": "#/1354"
+ "$ref": "#/1363"
},
"flags": 1,
"description": "Copy source type."
@@ -27989,7 +28219,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1356"
+ "$ref": "#/1365"
},
"flags": 0,
"description": "The settings that will be leveraged for SAP HANA source partitioning."
@@ -28010,7 +28240,7 @@
},
"type": {
"type": {
- "$ref": "#/1357"
+ "$ref": "#/1366"
},
"flags": 1,
"description": "Copy source type."
@@ -28082,7 +28312,7 @@
},
"type": {
"type": {
- "$ref": "#/1359"
+ "$ref": "#/1368"
},
"flags": 1,
"description": "Copy source type."
@@ -28141,7 +28371,7 @@
},
"type": {
"type": {
- "$ref": "#/1361"
+ "$ref": "#/1370"
},
"flags": 1,
"description": "Copy source type."
@@ -28214,7 +28444,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1363"
+ "$ref": "#/1372"
},
"flags": 0,
"description": "The settings that will be leveraged for SAP table source partitioning."
@@ -28235,7 +28465,7 @@
},
"type": {
"type": {
- "$ref": "#/1364"
+ "$ref": "#/1373"
},
"flags": 1,
"description": "Copy source type."
@@ -28307,7 +28537,7 @@
},
"type": {
"type": {
- "$ref": "#/1366"
+ "$ref": "#/1375"
},
"flags": 1,
"description": "Copy source type."
@@ -28324,7 +28554,7 @@
"properties": {
"expression": {
"type": {
- "$ref": "#/1368"
+ "$ref": "#/1377"
},
"flags": 0,
"description": "Expression to filter data from source."
@@ -28352,7 +28582,7 @@
},
"type": {
"type": {
- "$ref": "#/1377"
+ "$ref": "#/1386"
},
"flags": 1,
"description": "Copy source type."
@@ -28365,7 +28595,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1374"
+ "$ref": "#/1383"
},
"flags": 0,
"description": "Type of expressions supported by the system. Type: string."
@@ -28379,14 +28609,14 @@
},
"operators": {
"type": {
- "$ref": "#/1375"
+ "$ref": "#/1384"
},
"flags": 0,
"description": "Expression operator value Type: list of strings."
},
"operands": {
"type": {
- "$ref": "#/1376"
+ "$ref": "#/1385"
},
"flags": 0,
"description": "List of nested expressions."
@@ -28417,19 +28647,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1369"
+ "$ref": "#/1378"
},
{
- "$ref": "#/1370"
+ "$ref": "#/1379"
},
{
- "$ref": "#/1371"
+ "$ref": "#/1380"
},
{
- "$ref": "#/1372"
+ "$ref": "#/1381"
},
{
- "$ref": "#/1373"
+ "$ref": "#/1382"
},
{
"$ref": "#/2"
@@ -28445,7 +28675,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1368"
+ "$ref": "#/1377"
}
},
{
@@ -28472,7 +28702,7 @@
},
"type": {
"type": {
- "$ref": "#/1379"
+ "$ref": "#/1388"
},
"flags": 1,
"description": "Copy source type."
@@ -28510,7 +28740,7 @@
},
"type": {
"type": {
- "$ref": "#/1381"
+ "$ref": "#/1390"
},
"flags": 1,
"description": "Copy source type."
@@ -28534,14 +28764,14 @@
},
"exportSettings": {
"type": {
- "$ref": "#/1383"
+ "$ref": "#/1392"
},
"flags": 1,
"description": "Snowflake export settings."
},
"type": {
"type": {
- "$ref": "#/1386"
+ "$ref": "#/1395"
},
"flags": 1,
"description": "Copy source type."
@@ -28554,14 +28784,14 @@
"properties": {
"additionalCopyOptions": {
"type": {
- "$ref": "#/1384"
+ "$ref": "#/1393"
},
"flags": 0,
"description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }"
},
"additionalFormatOptions": {
"type": {
- "$ref": "#/1385"
+ "$ref": "#/1394"
},
"flags": 0,
"description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }"
@@ -28618,14 +28848,14 @@
},
"exportSettings": {
"type": {
- "$ref": "#/1383"
+ "$ref": "#/1392"
},
"flags": 1,
"description": "Snowflake export settings."
},
"type": {
"type": {
- "$ref": "#/1388"
+ "$ref": "#/1397"
},
"flags": 1,
"description": "Copy source type."
@@ -28663,7 +28893,7 @@
},
"type": {
"type": {
- "$ref": "#/1390"
+ "$ref": "#/1399"
},
"flags": 1,
"description": "Copy source type."
@@ -28715,7 +28945,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -28736,7 +28966,7 @@
},
"type": {
"type": {
- "$ref": "#/1392"
+ "$ref": "#/1401"
},
"flags": 1,
"description": "Copy source type."
@@ -28795,7 +29025,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -28816,7 +29046,7 @@
},
"type": {
"type": {
- "$ref": "#/1394"
+ "$ref": "#/1403"
},
"flags": 1,
"description": "Copy source type."
@@ -28875,7 +29105,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -28896,7 +29126,7 @@
},
"type": {
"type": {
- "$ref": "#/1396"
+ "$ref": "#/1405"
},
"flags": 1,
"description": "Copy source type."
@@ -28948,7 +29178,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -28969,7 +29199,7 @@
},
"type": {
"type": {
- "$ref": "#/1398"
+ "$ref": "#/1407"
},
"flags": 1,
"description": "Copy source type."
@@ -29007,7 +29237,7 @@
},
"type": {
"type": {
- "$ref": "#/1400"
+ "$ref": "#/1409"
},
"flags": 1,
"description": "Copy source type."
@@ -29045,7 +29275,7 @@
},
"type": {
"type": {
- "$ref": "#/1402"
+ "$ref": "#/1411"
},
"flags": 1,
"description": "Copy source type."
@@ -29076,7 +29306,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1404"
+ "$ref": "#/1413"
},
"flags": 0,
"description": "The settings that will be leveraged for teradata source partitioning."
@@ -29097,7 +29327,7 @@
},
"type": {
"type": {
- "$ref": "#/1405"
+ "$ref": "#/1414"
},
"flags": 1,
"description": "Copy source type."
@@ -29162,7 +29392,7 @@
},
"type": {
"type": {
- "$ref": "#/1407"
+ "$ref": "#/1416"
},
"flags": 1,
"description": "Copy source type."
@@ -29214,7 +29444,7 @@
},
"partitionSettings": {
"type": {
- "$ref": "#/1144"
+ "$ref": "#/1153"
},
"flags": 0,
"description": "The settings that will be leveraged for Sql source partitioning."
@@ -29235,7 +29465,7 @@
},
"type": {
"type": {
- "$ref": "#/1409"
+ "$ref": "#/1418"
},
"flags": 1,
"description": "Copy source type."
@@ -29273,7 +29503,7 @@
},
"type": {
"type": {
- "$ref": "#/1411"
+ "$ref": "#/1420"
},
"flags": 1,
"description": "Copy source type."
@@ -29311,7 +29541,7 @@
},
"type": {
"type": {
- "$ref": "#/1413"
+ "$ref": "#/1422"
},
"flags": 1,
"description": "Copy source type."
@@ -29335,7 +29565,7 @@
},
"type": {
"type": {
- "$ref": "#/1415"
+ "$ref": "#/1424"
},
"flags": 1,
"description": "Copy source type."
@@ -29352,14 +29582,14 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Xml store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1417"
+ "$ref": "#/1426"
},
"flags": 0,
"description": "Xml format settings."
@@ -29373,7 +29603,7 @@
},
"type": {
"type": {
- "$ref": "#/1418"
+ "$ref": "#/1427"
},
"flags": 1,
"description": "Copy source type."
@@ -29386,7 +29616,7 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
@@ -29485,142 +29715,142 @@
},
"elements": {
"AvroSink": {
- "$ref": "#/1420"
+ "$ref": "#/1429"
},
"AzureBlobFSSink": {
- "$ref": "#/1440"
+ "$ref": "#/1449"
},
"AzureDataExplorerSink": {
- "$ref": "#/1443"
+ "$ref": "#/1452"
},
"AzureDataLakeStoreSink": {
- "$ref": "#/1445"
+ "$ref": "#/1454"
},
"AzureDatabricksDeltaLakeSink": {
- "$ref": "#/1447"
+ "$ref": "#/1456"
},
"AzureMySqlSink": {
- "$ref": "#/1450"
+ "$ref": "#/1459"
},
"AzurePostgreSqlSink": {
- "$ref": "#/1452"
+ "$ref": "#/1461"
},
"AzureQueueSink": {
- "$ref": "#/1454"
+ "$ref": "#/1468"
},
"AzureSearchIndexSink": {
- "$ref": "#/1456"
+ "$ref": "#/1470"
},
"AzureSqlSink": {
- "$ref": "#/1461"
+ "$ref": "#/1475"
},
"AzureTableSink": {
- "$ref": "#/1464"
+ "$ref": "#/1478"
},
"BinarySink": {
- "$ref": "#/1466"
+ "$ref": "#/1480"
},
"BlobSink": {
- "$ref": "#/1468"
+ "$ref": "#/1482"
},
"CommonDataServiceForAppsSink": {
- "$ref": "#/1471"
+ "$ref": "#/1485"
},
"CosmosDbMongoDbApiSink": {
- "$ref": "#/1475"
+ "$ref": "#/1489"
},
"CosmosDbSqlApiSink": {
- "$ref": "#/1477"
+ "$ref": "#/1491"
},
"DelimitedTextSink": {
- "$ref": "#/1479"
+ "$ref": "#/1493"
},
"DocumentDbCollectionSink": {
- "$ref": "#/1482"
+ "$ref": "#/1496"
},
"DynamicsCrmSink": {
- "$ref": "#/1484"
+ "$ref": "#/1498"
},
"DynamicsSink": {
- "$ref": "#/1488"
+ "$ref": "#/1502"
},
"FileSystemSink": {
- "$ref": "#/1492"
+ "$ref": "#/1506"
},
"IcebergSink": {
- "$ref": "#/1494"
+ "$ref": "#/1508"
},
"InformixSink": {
- "$ref": "#/1497"
+ "$ref": "#/1511"
},
"JsonSink": {
- "$ref": "#/1499"
+ "$ref": "#/1513"
},
"LakeHouseTableSink": {
- "$ref": "#/1502"
+ "$ref": "#/1516"
},
"MicrosoftAccessSink": {
- "$ref": "#/1504"
+ "$ref": "#/1518"
},
"MongoDbAtlasSink": {
- "$ref": "#/1506"
+ "$ref": "#/1520"
},
"MongoDbV2Sink": {
- "$ref": "#/1508"
+ "$ref": "#/1522"
},
"OdbcSink": {
- "$ref": "#/1510"
+ "$ref": "#/1524"
},
"OracleSink": {
- "$ref": "#/1512"
+ "$ref": "#/1526"
},
"OrcSink": {
- "$ref": "#/1514"
+ "$ref": "#/1528"
},
"ParquetSink": {
- "$ref": "#/1517"
+ "$ref": "#/1531"
},
"RestSink": {
- "$ref": "#/1520"
+ "$ref": "#/1534"
},
"SalesforceServiceCloudSink": {
- "$ref": "#/1522"
+ "$ref": "#/1536"
},
"SalesforceServiceCloudV2Sink": {
- "$ref": "#/1527"
+ "$ref": "#/1541"
},
"SalesforceSink": {
- "$ref": "#/1532"
+ "$ref": "#/1546"
},
"SalesforceV2Sink": {
- "$ref": "#/1537"
+ "$ref": "#/1551"
},
"SapCloudForCustomerSink": {
- "$ref": "#/1542"
+ "$ref": "#/1556"
},
"SnowflakeSink": {
- "$ref": "#/1547"
+ "$ref": "#/1561"
},
"SnowflakeV2Sink": {
- "$ref": "#/1552"
+ "$ref": "#/1566"
},
"SqlDWSink": {
- "$ref": "#/1554"
+ "$ref": "#/1568"
},
"SqlMISink": {
- "$ref": "#/1565"
+ "$ref": "#/1579"
},
"SqlServerSink": {
- "$ref": "#/1567"
+ "$ref": "#/1581"
},
"SqlSink": {
- "$ref": "#/1569"
+ "$ref": "#/1583"
},
"TeradataSink": {
- "$ref": "#/1571"
+ "$ref": "#/1585"
},
"WarehouseSink": {
- "$ref": "#/1574"
+ "$ref": "#/1588"
}
}
},
@@ -29630,21 +29860,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "Avro store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1438"
+ "$ref": "#/1447"
},
"flags": 0,
"description": "Avro format settings."
},
"type": {
"type": {
- "$ref": "#/1439"
+ "$ref": "#/1448"
},
"flags": 1,
"description": "Copy sink type."
@@ -29679,7 +29909,7 @@
},
"metadata": {
"type": {
- "$ref": "#/1423"
+ "$ref": "#/1432"
},
"flags": 0,
"description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects)."
@@ -29687,25 +29917,25 @@
},
"elements": {
"AzureBlobFSWriteSettings": {
- "$ref": "#/1424"
+ "$ref": "#/1433"
},
"AzureBlobStorageWriteSettings": {
- "$ref": "#/1426"
+ "$ref": "#/1435"
},
"AzureDataLakeStoreWriteSettings": {
- "$ref": "#/1428"
+ "$ref": "#/1437"
},
"AzureFileStorageWriteSettings": {
- "$ref": "#/1430"
+ "$ref": "#/1439"
},
"FileServerWriteSettings": {
- "$ref": "#/1432"
+ "$ref": "#/1441"
},
"LakeHouseWriteSettings": {
- "$ref": "#/1434"
+ "$ref": "#/1443"
},
"SftpWriteSettings": {
- "$ref": "#/1436"
+ "$ref": "#/1445"
}
}
},
@@ -29732,7 +29962,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1422"
+ "$ref": "#/1431"
}
},
{
@@ -29748,7 +29978,7 @@
},
"type": {
"type": {
- "$ref": "#/1425"
+ "$ref": "#/1434"
},
"flags": 1,
"description": "The write setting type."
@@ -29772,7 +30002,7 @@
},
"type": {
"type": {
- "$ref": "#/1427"
+ "$ref": "#/1436"
},
"flags": 1,
"description": "The write setting type."
@@ -29796,7 +30026,7 @@
},
"type": {
"type": {
- "$ref": "#/1429"
+ "$ref": "#/1438"
},
"flags": 1,
"description": "The write setting type."
@@ -29813,7 +30043,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1431"
+ "$ref": "#/1440"
},
"flags": 1,
"description": "The write setting type."
@@ -29830,7 +30060,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1433"
+ "$ref": "#/1442"
},
"flags": 1,
"description": "The write setting type."
@@ -29847,7 +30077,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1435"
+ "$ref": "#/1444"
},
"flags": 1,
"description": "The write setting type."
@@ -29878,7 +30108,7 @@
},
"type": {
"type": {
- "$ref": "#/1437"
+ "$ref": "#/1446"
},
"flags": 1,
"description": "The write setting type."
@@ -29950,14 +30180,14 @@
},
"metadata": {
"type": {
- "$ref": "#/1441"
+ "$ref": "#/1450"
},
"flags": 0,
"description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects)."
},
"type": {
"type": {
- "$ref": "#/1442"
+ "$ref": "#/1451"
},
"flags": 1,
"description": "Copy sink type."
@@ -29967,7 +30197,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1422"
+ "$ref": "#/1431"
}
},
{
@@ -30001,7 +30231,7 @@
},
"type": {
"type": {
- "$ref": "#/1444"
+ "$ref": "#/1453"
},
"flags": 1,
"description": "Copy sink type."
@@ -30032,7 +30262,7 @@
},
"type": {
"type": {
- "$ref": "#/1446"
+ "$ref": "#/1455"
},
"flags": 1,
"description": "Copy sink type."
@@ -30056,14 +30286,14 @@
},
"importSettings": {
"type": {
- "$ref": "#/1448"
+ "$ref": "#/1457"
},
"flags": 0,
"description": "Azure Databricks Delta Lake import settings."
},
"type": {
"type": {
- "$ref": "#/1449"
+ "$ref": "#/1458"
},
"flags": 1,
"description": "Copy sink type."
@@ -30117,7 +30347,7 @@
},
"type": {
"type": {
- "$ref": "#/1451"
+ "$ref": "#/1460"
},
"flags": 1,
"description": "Copy sink type."
@@ -30139,15 +30369,71 @@
"flags": 0,
"description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)."
},
+ "writeMethod": {
+ "type": {
+ "$ref": "#/1465"
+ },
+ "flags": 0,
+ "description": "The write behavior for the operation. Default is Bulk Insert."
+ },
+ "upsertSettings": {
+ "type": {
+ "$ref": "#/1466"
+ },
+ "flags": 0,
+ "description": "Azure Database for PostgreSQL upsert option settings"
+ },
"type": {
"type": {
- "$ref": "#/1453"
+ "$ref": "#/1467"
},
"flags": 1,
"description": "Copy sink type."
}
}
},
+ {
+ "$type": "StringLiteralType",
+ "value": "BulkInsert"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CopyCommand"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Upsert"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1462"
+ },
+ {
+ "$ref": "#/1463"
+ },
+ {
+ "$ref": "#/1464"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzurePostgreSqlSinkUpsertSettings",
+ "properties": {
+ "keys": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings)."
+ }
+ }
+ },
{
"$type": "StringLiteralType",
"value": "AzurePostgreSqlSink"
@@ -30158,7 +30444,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1455"
+ "$ref": "#/1469"
},
"flags": 1,
"description": "Copy sink type."
@@ -30175,14 +30461,14 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1459"
+ "$ref": "#/1473"
},
"flags": 0,
"description": "Specify the write behavior when upserting documents into Azure Search Index."
},
"type": {
"type": {
- "$ref": "#/1460"
+ "$ref": "#/1474"
},
"flags": 1,
"description": "Copy sink type."
@@ -30201,10 +30487,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1457"
+ "$ref": "#/1471"
},
{
- "$ref": "#/1458"
+ "$ref": "#/1472"
},
{
"$ref": "#/2"
@@ -30277,14 +30563,14 @@
},
"upsertSettings": {
"type": {
- "$ref": "#/1462"
+ "$ref": "#/1476"
},
"flags": 0,
"description": "SQL upsert settings."
},
"type": {
"type": {
- "$ref": "#/1463"
+ "$ref": "#/1477"
},
"flags": 1,
"description": "Copy sink type."
@@ -30356,7 +30642,7 @@
},
"type": {
"type": {
- "$ref": "#/1465"
+ "$ref": "#/1479"
},
"flags": 1,
"description": "Copy sink type."
@@ -30373,14 +30659,14 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "Binary store settings."
},
"type": {
"type": {
- "$ref": "#/1467"
+ "$ref": "#/1481"
},
"flags": 1,
"description": "Copy sink type."
@@ -30425,14 +30711,14 @@
},
"metadata": {
"type": {
- "$ref": "#/1469"
+ "$ref": "#/1483"
},
"flags": 0,
"description": "Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects)."
},
"type": {
"type": {
- "$ref": "#/1470"
+ "$ref": "#/1484"
},
"flags": 1,
"description": "Copy sink type."
@@ -30442,7 +30728,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1422"
+ "$ref": "#/1431"
}
},
{
@@ -30455,7 +30741,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1473"
+ "$ref": "#/1487"
},
"flags": 1,
"description": "The write behavior for the operation."
@@ -30474,9 +30760,23 @@
"flags": 0,
"description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)."
},
+ "bypassBusinessLogicExecution": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)."
+ },
+ "bypassPowerAutomateFlows": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean)."
+ },
"type": {
"type": {
- "$ref": "#/1474"
+ "$ref": "#/1488"
},
"flags": 1,
"description": "Copy sink type."
@@ -30491,7 +30791,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1472"
+ "$ref": "#/1486"
},
{
"$ref": "#/2"
@@ -30515,7 +30815,7 @@
},
"type": {
"type": {
- "$ref": "#/1476"
+ "$ref": "#/1490"
},
"flags": 1,
"description": "Copy sink type."
@@ -30539,7 +30839,7 @@
},
"type": {
"type": {
- "$ref": "#/1478"
+ "$ref": "#/1492"
},
"flags": 1,
"description": "Copy sink type."
@@ -30556,21 +30856,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "DelimitedText store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1480"
+ "$ref": "#/1494"
},
"flags": 0,
"description": "DelimitedText format settings."
},
"type": {
"type": {
- "$ref": "#/1481"
+ "$ref": "#/1495"
},
"flags": 1,
"description": "Copy sink type."
@@ -30645,7 +30945,7 @@
},
"type": {
"type": {
- "$ref": "#/1483"
+ "$ref": "#/1497"
},
"flags": 1,
"description": "Copy sink type."
@@ -30662,7 +30962,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1486"
+ "$ref": "#/1500"
},
"flags": 1,
"description": "The write behavior for the operation."
@@ -30681,9 +30981,23 @@
"flags": 0,
"description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)."
},
+ "bypassBusinessLogicExecution": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)."
+ },
+ "bypassPowerAutomateFlows": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean)."
+ },
"type": {
"type": {
- "$ref": "#/1487"
+ "$ref": "#/1501"
},
"flags": 1,
"description": "Copy sink type."
@@ -30698,7 +31012,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1485"
+ "$ref": "#/1499"
},
{
"$ref": "#/2"
@@ -30715,7 +31029,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1490"
+ "$ref": "#/1504"
},
"flags": 1,
"description": "The write behavior for the operation."
@@ -30734,9 +31048,23 @@
"flags": 0,
"description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)."
},
+ "bypassBusinessLogicExecution": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)."
+ },
+ "bypassPowerAutomateFlows": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 0,
+ "description": "Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean)."
+ },
"type": {
"type": {
- "$ref": "#/1491"
+ "$ref": "#/1505"
},
"flags": 1,
"description": "Copy sink type."
@@ -30751,7 +31079,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1489"
+ "$ref": "#/1503"
},
{
"$ref": "#/2"
@@ -30775,7 +31103,7 @@
},
"type": {
"type": {
- "$ref": "#/1493"
+ "$ref": "#/1507"
},
"flags": 1,
"description": "Copy sink type."
@@ -30792,21 +31120,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "Iceberg store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1495"
+ "$ref": "#/1509"
},
"flags": 0,
"description": "Iceberg format settings."
},
"type": {
"type": {
- "$ref": "#/1496"
+ "$ref": "#/1510"
},
"flags": 1,
"description": "Copy sink type."
@@ -30846,7 +31174,7 @@
},
"type": {
"type": {
- "$ref": "#/1498"
+ "$ref": "#/1512"
},
"flags": 1,
"description": "Copy sink type."
@@ -30863,21 +31191,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "Json store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1500"
+ "$ref": "#/1514"
},
"flags": 0,
"description": "Json format settings."
},
"type": {
"type": {
- "$ref": "#/1501"
+ "$ref": "#/1515"
},
"flags": 1,
"description": "Copy sink type."
@@ -30938,7 +31266,7 @@
},
"type": {
"type": {
- "$ref": "#/1503"
+ "$ref": "#/1517"
},
"flags": 1,
"description": "Copy sink type."
@@ -30962,7 +31290,7 @@
},
"type": {
"type": {
- "$ref": "#/1505"
+ "$ref": "#/1519"
},
"flags": 1,
"description": "Copy sink type."
@@ -30986,7 +31314,7 @@
},
"type": {
"type": {
- "$ref": "#/1507"
+ "$ref": "#/1521"
},
"flags": 1,
"description": "Copy sink type."
@@ -31010,7 +31338,7 @@
},
"type": {
"type": {
- "$ref": "#/1509"
+ "$ref": "#/1523"
},
"flags": 1,
"description": "Copy sink type."
@@ -31034,7 +31362,7 @@
},
"type": {
"type": {
- "$ref": "#/1511"
+ "$ref": "#/1525"
},
"flags": 1,
"description": "Copy sink type."
@@ -31058,7 +31386,7 @@
},
"type": {
"type": {
- "$ref": "#/1513"
+ "$ref": "#/1527"
},
"flags": 1,
"description": "Copy sink type."
@@ -31075,21 +31403,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "ORC store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1515"
+ "$ref": "#/1529"
},
"flags": 0,
"description": "ORC format settings."
},
"type": {
"type": {
- "$ref": "#/1516"
+ "$ref": "#/1530"
},
"flags": 1,
"description": "Copy sink type."
@@ -31136,21 +31464,21 @@
"properties": {
"storeSettings": {
"type": {
- "$ref": "#/1421"
+ "$ref": "#/1430"
},
"flags": 0,
"description": "Parquet store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1518"
+ "$ref": "#/1532"
},
"flags": 0,
"description": "Parquet format settings."
},
"type": {
"type": {
- "$ref": "#/1519"
+ "$ref": "#/1533"
},
"flags": 1,
"description": "Copy sink type."
@@ -31232,7 +31560,7 @@
},
"type": {
"type": {
- "$ref": "#/1521"
+ "$ref": "#/1535"
},
"flags": 1,
"description": "Copy sink type."
@@ -31249,7 +31577,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1525"
+ "$ref": "#/1539"
},
"flags": 0,
"description": "The write behavior for the operation. Default is Insert."
@@ -31270,7 +31598,7 @@
},
"type": {
"type": {
- "$ref": "#/1526"
+ "$ref": "#/1540"
},
"flags": 1,
"description": "Copy sink type."
@@ -31289,10 +31617,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1523"
+ "$ref": "#/1537"
},
{
- "$ref": "#/1524"
+ "$ref": "#/1538"
},
{
"$ref": "#/2"
@@ -31309,7 +31637,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1530"
+ "$ref": "#/1544"
},
"flags": 0,
"description": "The write behavior for the operation. Default is Insert."
@@ -31330,7 +31658,7 @@
},
"type": {
"type": {
- "$ref": "#/1531"
+ "$ref": "#/1545"
},
"flags": 1,
"description": "Copy sink type."
@@ -31349,10 +31677,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1528"
+ "$ref": "#/1542"
},
{
- "$ref": "#/1529"
+ "$ref": "#/1543"
},
{
"$ref": "#/2"
@@ -31369,7 +31697,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1535"
+ "$ref": "#/1549"
},
"flags": 0,
"description": "The write behavior for the operation. Default is Insert."
@@ -31390,7 +31718,7 @@
},
"type": {
"type": {
- "$ref": "#/1536"
+ "$ref": "#/1550"
},
"flags": 1,
"description": "Copy sink type."
@@ -31409,10 +31737,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1533"
+ "$ref": "#/1547"
},
{
- "$ref": "#/1534"
+ "$ref": "#/1548"
},
{
"$ref": "#/2"
@@ -31429,7 +31757,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1540"
+ "$ref": "#/1554"
},
"flags": 0,
"description": "The write behavior for the operation. Default is Insert."
@@ -31450,7 +31778,7 @@
},
"type": {
"type": {
- "$ref": "#/1541"
+ "$ref": "#/1555"
},
"flags": 1,
"description": "Copy sink type."
@@ -31469,10 +31797,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1538"
+ "$ref": "#/1552"
},
{
- "$ref": "#/1539"
+ "$ref": "#/1553"
},
{
"$ref": "#/2"
@@ -31489,7 +31817,7 @@
"properties": {
"writeBehavior": {
"type": {
- "$ref": "#/1545"
+ "$ref": "#/1559"
},
"flags": 0,
"description": "The write behavior for the operation. Default is 'Insert'."
@@ -31503,7 +31831,7 @@
},
"type": {
"type": {
- "$ref": "#/1546"
+ "$ref": "#/1560"
},
"flags": 1,
"description": "Copy sink type."
@@ -31522,10 +31850,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1543"
+ "$ref": "#/1557"
},
{
- "$ref": "#/1544"
+ "$ref": "#/1558"
},
{
"$ref": "#/2"
@@ -31549,14 +31877,14 @@
},
"importSettings": {
"type": {
- "$ref": "#/1548"
+ "$ref": "#/1562"
},
"flags": 0,
"description": "Snowflake import settings."
},
"type": {
"type": {
- "$ref": "#/1551"
+ "$ref": "#/1565"
},
"flags": 1,
"description": "Copy sink type."
@@ -31569,14 +31897,14 @@
"properties": {
"additionalCopyOptions": {
"type": {
- "$ref": "#/1549"
+ "$ref": "#/1563"
},
"flags": 0,
"description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }"
},
"additionalFormatOptions": {
"type": {
- "$ref": "#/1550"
+ "$ref": "#/1564"
},
"flags": 0,
"description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }"
@@ -31633,14 +31961,14 @@
},
"importSettings": {
"type": {
- "$ref": "#/1548"
+ "$ref": "#/1562"
},
"flags": 0,
"description": "Snowflake import settings."
},
"type": {
"type": {
- "$ref": "#/1553"
+ "$ref": "#/1567"
},
"flags": 1,
"description": "Copy sink type."
@@ -31671,7 +31999,7 @@
},
"polyBaseSettings": {
"type": {
- "$ref": "#/1555"
+ "$ref": "#/1569"
},
"flags": 0,
"description": "Specifies PolyBase-related settings when allowPolyBase is true."
@@ -31685,7 +32013,7 @@
},
"copyCommandSettings": {
"type": {
- "$ref": "#/1559"
+ "$ref": "#/1573"
},
"flags": 0,
"description": "Specifies Copy Command related settings when allowCopyCommand is true."
@@ -31713,14 +32041,14 @@
},
"upsertSettings": {
"type": {
- "$ref": "#/1563"
+ "$ref": "#/1577"
},
"flags": 0,
"description": "SQL DW upsert settings."
},
"type": {
"type": {
- "$ref": "#/1564"
+ "$ref": "#/1578"
},
"flags": 1,
"description": "Copy sink type."
@@ -31733,7 +32061,7 @@
"properties": {
"rejectType": {
"type": {
- "$ref": "#/1558"
+ "$ref": "#/1572"
},
"flags": 0,
"description": "Reject type."
@@ -31776,10 +32104,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1556"
+ "$ref": "#/1570"
},
{
- "$ref": "#/1557"
+ "$ref": "#/1571"
},
{
"$ref": "#/2"
@@ -31792,14 +32120,14 @@
"properties": {
"defaultValues": {
"type": {
- "$ref": "#/1561"
+ "$ref": "#/1575"
},
"flags": 0,
"description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects)."
},
"additionalOptions": {
"type": {
- "$ref": "#/1562"
+ "$ref": "#/1576"
},
"flags": 0,
"description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }"
@@ -31829,7 +32157,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1560"
+ "$ref": "#/1574"
}
},
{
@@ -31926,14 +32254,14 @@
},
"upsertSettings": {
"type": {
- "$ref": "#/1462"
+ "$ref": "#/1476"
},
"flags": 0,
"description": "SQL upsert settings."
},
"type": {
"type": {
- "$ref": "#/1566"
+ "$ref": "#/1580"
},
"flags": 1,
"description": "Copy sink type."
@@ -32006,14 +32334,14 @@
},
"upsertSettings": {
"type": {
- "$ref": "#/1462"
+ "$ref": "#/1476"
},
"flags": 0,
"description": "SQL upsert settings."
},
"type": {
"type": {
- "$ref": "#/1568"
+ "$ref": "#/1582"
},
"flags": 1,
"description": "Copy sink type."
@@ -32086,14 +32414,14 @@
},
"upsertSettings": {
"type": {
- "$ref": "#/1462"
+ "$ref": "#/1476"
},
"flags": 0,
"description": "SQL upsert settings."
},
"type": {
"type": {
- "$ref": "#/1570"
+ "$ref": "#/1584"
},
"flags": 1,
"description": "Copy sink type."
@@ -32110,14 +32438,14 @@
"properties": {
"importSettings": {
"type": {
- "$ref": "#/1572"
+ "$ref": "#/1586"
},
"flags": 0,
"description": "Teradata import settings."
},
"type": {
"type": {
- "$ref": "#/1573"
+ "$ref": "#/1587"
},
"flags": 1,
"description": "Copy sink type."
@@ -32171,7 +32499,7 @@
},
"copyCommandSettings": {
"type": {
- "$ref": "#/1559"
+ "$ref": "#/1573"
},
"flags": 0,
"description": "Specifies Copy Command related settings when allowCopyCommand is true."
@@ -32192,7 +32520,7 @@
},
"type": {
"type": {
- "$ref": "#/1575"
+ "$ref": "#/1589"
},
"flags": 1,
"description": "Copy sink type."
@@ -32306,14 +32634,14 @@
},
"copyActivityLogSettings": {
"type": {
- "$ref": "#/1580"
+ "$ref": "#/1594"
},
"flags": 0,
"description": "Specifies settings for copy activity log."
},
"logLocationSettings": {
"type": {
- "$ref": "#/1581"
+ "$ref": "#/1595"
},
"flags": 1,
"description": "Log location settings customer needs to provide when enabling log."
@@ -32395,13 +32723,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
}
},
{
@@ -32414,7 +32742,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1589"
+ "$ref": "#/1603"
},
"flags": 1,
"description": "Custom activity properties."
@@ -32428,14 +32756,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1594"
+ "$ref": "#/1608"
},
"flags": 1,
"description": "Type of activity."
@@ -32469,14 +32797,14 @@
},
"referenceObjects": {
"type": {
- "$ref": "#/1590"
+ "$ref": "#/1604"
},
"flags": 0,
"description": "Reference objects"
},
"extendedProperties": {
"type": {
- "$ref": "#/1593"
+ "$ref": "#/1607"
},
"flags": 0,
"description": "User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined."
@@ -32503,14 +32831,14 @@
"properties": {
"linkedServices": {
"type": {
- "$ref": "#/1591"
+ "$ref": "#/1605"
},
"flags": 0,
"description": "Linked service references."
},
"datasets": {
"type": {
- "$ref": "#/1592"
+ "$ref": "#/1606"
},
"flags": 0,
"description": "Dataset references."
@@ -32526,7 +32854,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
}
},
{
@@ -32547,7 +32875,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1596"
+ "$ref": "#/1610"
},
"flags": 1,
"description": "Data Lake Analytics U-SQL activity properties."
@@ -32561,14 +32889,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1598"
+ "$ref": "#/1612"
},
"flags": 1,
"description": "Type of activity."
@@ -32609,7 +32937,7 @@
},
"parameters": {
"type": {
- "$ref": "#/1597"
+ "$ref": "#/1611"
},
"flags": 0,
"description": "Parameters for U-SQL job request."
@@ -32648,7 +32976,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1600"
+ "$ref": "#/1614"
},
"flags": 1,
"description": "Databricks Notebook activity properties."
@@ -32662,14 +32990,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1604"
+ "$ref": "#/1618"
},
"flags": 1,
"description": "Type of activity."
@@ -32689,14 +33017,14 @@
},
"baseParameters": {
"type": {
- "$ref": "#/1601"
+ "$ref": "#/1615"
},
"flags": 0,
"description": "Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used."
},
"libraries": {
"type": {
- "$ref": "#/1603"
+ "$ref": "#/1617"
},
"flags": 0,
"description": "A list of libraries to be installed on the cluster that will execute the job."
@@ -32722,7 +33050,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1602"
+ "$ref": "#/1616"
}
},
{
@@ -32735,7 +33063,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1606"
+ "$ref": "#/1620"
},
"flags": 1,
"description": "Databricks SparkJar activity properties."
@@ -32749,14 +33077,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1610"
+ "$ref": "#/1624"
},
"flags": 1,
"description": "Type of activity."
@@ -32776,14 +33104,14 @@
},
"parameters": {
"type": {
- "$ref": "#/1607"
+ "$ref": "#/1621"
},
"flags": 0,
"description": "Parameters that will be passed to the main method."
},
"libraries": {
"type": {
- "$ref": "#/1609"
+ "$ref": "#/1623"
},
"flags": 0,
"description": "A list of libraries to be installed on the cluster that will execute the job."
@@ -32807,7 +33135,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1608"
+ "$ref": "#/1622"
}
},
{
@@ -32820,7 +33148,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1612"
+ "$ref": "#/1626"
},
"flags": 1,
"description": "Databricks SparkPython activity properties."
@@ -32834,14 +33162,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1616"
+ "$ref": "#/1630"
},
"flags": 1,
"description": "Type of activity."
@@ -32861,14 +33189,14 @@
},
"parameters": {
"type": {
- "$ref": "#/1613"
+ "$ref": "#/1627"
},
"flags": 0,
"description": "Command line parameters that will be passed to the Python file."
},
"libraries": {
"type": {
- "$ref": "#/1615"
+ "$ref": "#/1629"
},
"flags": 0,
"description": "A list of libraries to be installed on the cluster that will execute the job."
@@ -32892,7 +33220,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1614"
+ "$ref": "#/1628"
}
},
{
@@ -32905,7 +33233,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1618"
+ "$ref": "#/1632"
},
"flags": 1,
"description": "Delete activity properties."
@@ -32919,14 +33247,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1619"
+ "$ref": "#/1633"
},
"flags": 1,
"description": "Type of activity."
@@ -32960,21 +33288,21 @@
},
"logStorageSettings": {
"type": {
- "$ref": "#/1578"
+ "$ref": "#/1592"
},
"flags": 0,
"description": "Log storage settings customer need to provide when enableLogging is true."
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 1,
"description": "Delete activity dataset reference."
},
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "Delete activity store settings."
@@ -32991,7 +33319,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1621"
+ "$ref": "#/1635"
},
"flags": 1,
"description": "Execute data flow activity properties."
@@ -33005,14 +33333,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1629"
+ "$ref": "#/1643"
},
"flags": 1,
"description": "Type of activity."
@@ -33025,14 +33353,14 @@
"properties": {
"dataFlow": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 1,
"description": "Data flow reference."
},
"staging": {
"type": {
- "$ref": "#/1626"
+ "$ref": "#/1640"
},
"flags": 0,
"description": "Staging info for execute data flow activity."
@@ -33046,14 +33374,14 @@
},
"continuationSettings": {
"type": {
- "$ref": "#/1627"
+ "$ref": "#/1641"
},
"flags": 0,
"description": "Continuation settings for execute data flow activity."
},
"compute": {
"type": {
- "$ref": "#/1628"
+ "$ref": "#/1642"
},
"flags": 0,
"description": "Compute properties for data flow activity."
@@ -33094,7 +33422,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1624"
+ "$ref": "#/1638"
},
"flags": 1,
"description": "Data flow reference type."
@@ -33115,7 +33443,7 @@
},
"parameters": {
"type": {
- "$ref": "#/1625"
+ "$ref": "#/1639"
},
"flags": 0,
"description": "Data flow parameters"
@@ -33133,7 +33461,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1623"
+ "$ref": "#/1637"
},
{
"$ref": "#/2"
@@ -33225,7 +33553,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1631"
+ "$ref": "#/1645"
},
"flags": 1,
"description": "Execute SSIS package activity properties."
@@ -33239,14 +33567,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1656"
+ "$ref": "#/1670"
},
"flags": 1,
"description": "Type of activity."
@@ -33259,7 +33587,7 @@
"properties": {
"packageLocation": {
"type": {
- "$ref": "#/1632"
+ "$ref": "#/1646"
},
"flags": 1,
"description": "SSIS package location."
@@ -33287,7 +33615,7 @@
},
"executionCredential": {
"type": {
- "$ref": "#/1642"
+ "$ref": "#/1656"
},
"flags": 0,
"description": "The package execution credential."
@@ -33301,42 +33629,42 @@
},
"projectParameters": {
"type": {
- "$ref": "#/1644"
+ "$ref": "#/1658"
},
"flags": 0,
"description": "The project level parameters to execute the SSIS package."
},
"packageParameters": {
"type": {
- "$ref": "#/1645"
+ "$ref": "#/1659"
},
"flags": 0,
"description": "The package level parameters to execute the SSIS package."
},
"projectConnectionManagers": {
"type": {
- "$ref": "#/1647"
+ "$ref": "#/1661"
},
"flags": 0,
"description": "The project level connection managers to execute the SSIS package."
},
"packageConnectionManagers": {
"type": {
- "$ref": "#/1649"
+ "$ref": "#/1663"
},
"flags": 0,
"description": "The package level connection managers to execute the SSIS package."
},
"propertyOverrides": {
"type": {
- "$ref": "#/1651"
+ "$ref": "#/1665"
},
"flags": 0,
"description": "The property overrides to execute the SSIS package."
},
"logLocation": {
"type": {
- "$ref": "#/1652"
+ "$ref": "#/1666"
},
"flags": 0,
"description": "SSIS package execution log location."
@@ -33356,14 +33684,14 @@
},
"type": {
"type": {
- "$ref": "#/1637"
+ "$ref": "#/1651"
},
"flags": 0,
"description": "The type of SSIS package location."
},
"typeProperties": {
"type": {
- "$ref": "#/1638"
+ "$ref": "#/1652"
},
"flags": 0,
"description": "SSIS package location properties."
@@ -33390,16 +33718,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1633"
+ "$ref": "#/1647"
},
{
- "$ref": "#/1634"
+ "$ref": "#/1648"
},
{
- "$ref": "#/1635"
+ "$ref": "#/1649"
},
{
- "$ref": "#/1636"
+ "$ref": "#/1650"
},
{
"$ref": "#/2"
@@ -33419,7 +33747,7 @@
},
"accessCredential": {
"type": {
- "$ref": "#/1639"
+ "$ref": "#/1653"
},
"flags": 0,
"description": "The package access credential."
@@ -33433,7 +33761,7 @@
},
"configurationAccessCredential": {
"type": {
- "$ref": "#/1639"
+ "$ref": "#/1653"
},
"flags": 0,
"description": "The configuration file access credential."
@@ -33461,7 +33789,7 @@
},
"childPackages": {
"type": {
- "$ref": "#/1641"
+ "$ref": "#/1655"
},
"flags": 0,
"description": "The embedded child package list."
@@ -33532,7 +33860,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1640"
+ "$ref": "#/1654"
}
},
{
@@ -33580,7 +33908,7 @@
"name": "ExecuteSsisPackageActivityTypePropertiesProjectParameters",
"properties": {},
"additionalProperties": {
- "$ref": "#/1643"
+ "$ref": "#/1657"
}
},
{
@@ -33588,7 +33916,7 @@
"name": "ExecuteSsisPackageActivityTypePropertiesPackageParameters",
"properties": {},
"additionalProperties": {
- "$ref": "#/1643"
+ "$ref": "#/1657"
}
},
{
@@ -33596,7 +33924,7 @@
"name": "SsisConnectionManager",
"properties": {},
"additionalProperties": {
- "$ref": "#/1643"
+ "$ref": "#/1657"
}
},
{
@@ -33604,7 +33932,7 @@
"name": "ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers",
"properties": {},
"additionalProperties": {
- "$ref": "#/1646"
+ "$ref": "#/1660"
}
},
{
@@ -33612,7 +33940,7 @@
"name": "SsisConnectionManager",
"properties": {},
"additionalProperties": {
- "$ref": "#/1643"
+ "$ref": "#/1657"
}
},
{
@@ -33620,7 +33948,7 @@
"name": "ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers",
"properties": {},
"additionalProperties": {
- "$ref": "#/1648"
+ "$ref": "#/1662"
}
},
{
@@ -33648,7 +33976,7 @@
"name": "ExecuteSsisPackageActivityTypePropertiesPropertyOverrides",
"properties": {},
"additionalProperties": {
- "$ref": "#/1650"
+ "$ref": "#/1664"
}
},
{
@@ -33664,14 +33992,14 @@
},
"type": {
"type": {
- "$ref": "#/1654"
+ "$ref": "#/1668"
},
"flags": 1,
"description": "The type of SSIS log location."
},
"typeProperties": {
"type": {
- "$ref": "#/1655"
+ "$ref": "#/1669"
},
"flags": 1,
"description": "SSIS package execution log location properties."
@@ -33686,7 +34014,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1653"
+ "$ref": "#/1667"
},
{
"$ref": "#/2"
@@ -33699,7 +34027,7 @@
"properties": {
"accessCredential": {
"type": {
- "$ref": "#/1639"
+ "$ref": "#/1653"
},
"flags": 0,
"description": "The package execution log access credential."
@@ -33723,21 +34051,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1658"
+ "$ref": "#/1672"
},
"flags": 1,
"description": "Execute power query activity properties."
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1664"
+ "$ref": "#/1678"
},
"flags": 1,
"description": "Type of activity."
@@ -33750,28 +34078,28 @@
"properties": {
"sinks": {
"type": {
- "$ref": "#/1660"
+ "$ref": "#/1674"
},
"flags": 0,
"description": "(Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName."
},
"queries": {
"type": {
- "$ref": "#/1663"
+ "$ref": "#/1677"
},
"flags": 0,
"description": "List of mapping for Power Query mashup query to sink dataset(s)."
},
"dataFlow": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 1,
"description": "Data flow reference."
},
"staging": {
"type": {
- "$ref": "#/1626"
+ "$ref": "#/1640"
},
"flags": 0,
"description": "Staging info for execute data flow activity."
@@ -33785,14 +34113,14 @@
},
"continuationSettings": {
"type": {
- "$ref": "#/1627"
+ "$ref": "#/1641"
},
"flags": 0,
"description": "Continuation settings for execute data flow activity."
},
"compute": {
"type": {
- "$ref": "#/1628"
+ "$ref": "#/1642"
},
"flags": 0,
"description": "Compute properties for data flow activity."
@@ -33868,7 +34196,7 @@
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 0,
"description": "Dataset reference."
@@ -33882,7 +34210,7 @@
},
"flowlet": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 0,
"description": "Flowlet Reference"
@@ -33894,7 +34222,7 @@
"name": "ExecutePowerQueryActivityTypePropertiesSinks",
"properties": {},
"additionalProperties": {
- "$ref": "#/1659"
+ "$ref": "#/1673"
}
},
{
@@ -33910,7 +34238,7 @@
},
"dataflowSinks": {
"type": {
- "$ref": "#/1662"
+ "$ref": "#/1676"
},
"flags": 0,
"description": "List of sinks mapped to Power Query mashup query."
@@ -33920,13 +34248,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1659"
+ "$ref": "#/1673"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1661"
+ "$ref": "#/1675"
}
},
{
@@ -33939,7 +34267,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1666"
+ "$ref": "#/1680"
},
"flags": 1,
"description": "GetMetadata activity properties."
@@ -33953,14 +34281,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1679"
+ "$ref": "#/1693"
},
"flags": 1,
"description": "Type of activity."
@@ -33973,28 +34301,28 @@
"properties": {
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 1,
"description": "GetMetadata activity dataset reference."
},
"fieldList": {
"type": {
- "$ref": "#/1667"
+ "$ref": "#/1681"
},
"flags": 0,
"description": "Fields of metadata to get from dataset."
},
"storeSettings": {
"type": {
- "$ref": "#/1150"
+ "$ref": "#/1159"
},
"flags": 0,
"description": "GetMetadata activity store settings."
},
"formatSettings": {
"type": {
- "$ref": "#/1668"
+ "$ref": "#/1682"
},
"flags": 0,
"description": "GetMetadata activity format settings."
@@ -34014,19 +34342,19 @@
"baseProperties": {},
"elements": {
"BinaryReadSettings": {
- "$ref": "#/1669"
+ "$ref": "#/1683"
},
"DelimitedTextReadSettings": {
- "$ref": "#/1671"
+ "$ref": "#/1685"
},
"JsonReadSettings": {
- "$ref": "#/1673"
+ "$ref": "#/1687"
},
"ParquetReadSettings": {
- "$ref": "#/1675"
+ "$ref": "#/1689"
},
"XmlReadSettings": {
- "$ref": "#/1677"
+ "$ref": "#/1691"
}
}
},
@@ -34036,14 +34364,14 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
},
"type": {
"type": {
- "$ref": "#/1670"
+ "$ref": "#/1684"
},
"flags": 1,
"description": "The read setting type."
@@ -34067,14 +34395,14 @@
},
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
},
"type": {
"type": {
- "$ref": "#/1672"
+ "$ref": "#/1686"
},
"flags": 1,
"description": "The read setting type."
@@ -34091,14 +34419,14 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
},
"type": {
"type": {
- "$ref": "#/1674"
+ "$ref": "#/1688"
},
"flags": 1,
"description": "The read setting type."
@@ -34115,14 +34443,14 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
},
"type": {
"type": {
- "$ref": "#/1676"
+ "$ref": "#/1690"
},
"flags": 1,
"description": "The read setting type."
@@ -34139,7 +34467,7 @@
"properties": {
"compressionProperties": {
"type": {
- "$ref": "#/1202"
+ "$ref": "#/1211"
},
"flags": 0,
"description": "Compression settings."
@@ -34174,7 +34502,7 @@
},
"type": {
"type": {
- "$ref": "#/1678"
+ "$ref": "#/1692"
},
"flags": 1,
"description": "The read setting type."
@@ -34195,7 +34523,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1681"
+ "$ref": "#/1695"
},
"flags": 1,
"description": "HDInsight Hive activity properties."
@@ -34209,14 +34537,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1690"
+ "$ref": "#/1704"
},
"flags": 1,
"description": "Type of activity."
@@ -34229,21 +34557,21 @@
"properties": {
"storageLinkedServices": {
"type": {
- "$ref": "#/1682"
+ "$ref": "#/1696"
},
"flags": 0,
"description": "Storage linked service references."
},
"arguments": {
"type": {
- "$ref": "#/1683"
+ "$ref": "#/1697"
},
"flags": 0,
"description": "User specified arguments to HDInsightActivity."
},
"getDebugInfo": {
"type": {
- "$ref": "#/1687"
+ "$ref": "#/1701"
},
"flags": 0,
"description": "Debug info option."
@@ -34264,14 +34592,14 @@
},
"defines": {
"type": {
- "$ref": "#/1688"
+ "$ref": "#/1702"
},
"flags": 0,
"description": "Allows user to specify defines for Hive job request."
},
"variables": {
"type": {
- "$ref": "#/1689"
+ "$ref": "#/1703"
},
"flags": 0,
"description": "User specified arguments under hivevar namespace."
@@ -34313,13 +34641,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1684"
+ "$ref": "#/1698"
},
{
- "$ref": "#/1685"
+ "$ref": "#/1699"
},
{
- "$ref": "#/1686"
+ "$ref": "#/1700"
},
{
"$ref": "#/2"
@@ -34352,7 +34680,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1692"
+ "$ref": "#/1706"
},
"flags": 1,
"description": "HDInsight MapReduce activity properties."
@@ -34366,14 +34694,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1701"
+ "$ref": "#/1715"
},
"flags": 1,
"description": "Type of activity."
@@ -34386,21 +34714,21 @@
"properties": {
"storageLinkedServices": {
"type": {
- "$ref": "#/1693"
+ "$ref": "#/1707"
},
"flags": 0,
"description": "Storage linked service references."
},
"arguments": {
"type": {
- "$ref": "#/1694"
+ "$ref": "#/1708"
},
"flags": 0,
"description": "User specified arguments to HDInsightActivity."
},
"getDebugInfo": {
"type": {
- "$ref": "#/1698"
+ "$ref": "#/1712"
},
"flags": 0,
"description": "Debug info option."
@@ -34428,14 +34756,14 @@
},
"jarLibs": {
"type": {
- "$ref": "#/1699"
+ "$ref": "#/1713"
},
"flags": 0,
"description": "Jar libs."
},
"defines": {
"type": {
- "$ref": "#/1700"
+ "$ref": "#/1714"
},
"flags": 0,
"description": "Allows user to specify defines for the MapReduce job request."
@@ -34470,13 +34798,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1695"
+ "$ref": "#/1709"
},
{
- "$ref": "#/1696"
+ "$ref": "#/1710"
},
{
- "$ref": "#/1697"
+ "$ref": "#/1711"
},
{
"$ref": "#/2"
@@ -34507,7 +34835,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1703"
+ "$ref": "#/1717"
},
"flags": 1,
"description": "HDInsight Pig activity properties."
@@ -34521,14 +34849,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1710"
+ "$ref": "#/1724"
},
"flags": 1,
"description": "Type of activity."
@@ -34541,7 +34869,7 @@
"properties": {
"storageLinkedServices": {
"type": {
- "$ref": "#/1704"
+ "$ref": "#/1718"
},
"flags": 0,
"description": "Storage linked service references."
@@ -34555,7 +34883,7 @@
},
"getDebugInfo": {
"type": {
- "$ref": "#/1708"
+ "$ref": "#/1722"
},
"flags": 0,
"description": "Debug info option."
@@ -34576,7 +34904,7 @@
},
"defines": {
"type": {
- "$ref": "#/1709"
+ "$ref": "#/1723"
},
"flags": 0,
"description": "Allows user to specify defines for Pig job request."
@@ -34605,13 +34933,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1705"
+ "$ref": "#/1719"
},
{
- "$ref": "#/1706"
+ "$ref": "#/1720"
},
{
- "$ref": "#/1707"
+ "$ref": "#/1721"
},
{
"$ref": "#/2"
@@ -34636,7 +34964,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1712"
+ "$ref": "#/1726"
},
"flags": 1,
"description": "HDInsight spark activity properties."
@@ -34650,14 +34978,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1719"
+ "$ref": "#/1733"
},
"flags": 1,
"description": "Type of activity."
@@ -34684,14 +35012,14 @@
},
"arguments": {
"type": {
- "$ref": "#/1713"
+ "$ref": "#/1727"
},
"flags": 0,
"description": "The user-specified arguments to HDInsightSparkActivity."
},
"getDebugInfo": {
"type": {
- "$ref": "#/1717"
+ "$ref": "#/1731"
},
"flags": 0,
"description": "Debug info option."
@@ -34719,7 +35047,7 @@
},
"sparkConfig": {
"type": {
- "$ref": "#/1718"
+ "$ref": "#/1732"
},
"flags": 0,
"description": "Spark configuration property."
@@ -34748,13 +35076,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1714"
+ "$ref": "#/1728"
},
{
- "$ref": "#/1715"
+ "$ref": "#/1729"
},
{
- "$ref": "#/1716"
+ "$ref": "#/1730"
},
{
"$ref": "#/2"
@@ -34779,7 +35107,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1721"
+ "$ref": "#/1735"
},
"flags": 1,
"description": "HDInsight streaming activity properties."
@@ -34793,14 +35121,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1731"
+ "$ref": "#/1745"
},
"flags": 1,
"description": "Type of activity."
@@ -34813,21 +35141,21 @@
"properties": {
"storageLinkedServices": {
"type": {
- "$ref": "#/1722"
+ "$ref": "#/1736"
},
"flags": 0,
"description": "Storage linked service references."
},
"arguments": {
"type": {
- "$ref": "#/1723"
+ "$ref": "#/1737"
},
"flags": 0,
"description": "User specified arguments to HDInsightActivity."
},
"getDebugInfo": {
"type": {
- "$ref": "#/1727"
+ "$ref": "#/1741"
},
"flags": 0,
"description": "Debug info option."
@@ -34862,7 +35190,7 @@
},
"filePaths": {
"type": {
- "$ref": "#/1728"
+ "$ref": "#/1742"
},
"flags": 1,
"description": "Paths to streaming job files. Can be directories."
@@ -34883,14 +35211,14 @@
},
"commandEnvironment": {
"type": {
- "$ref": "#/1729"
+ "$ref": "#/1743"
},
"flags": 0,
"description": "Command line environment values."
},
"defines": {
"type": {
- "$ref": "#/1730"
+ "$ref": "#/1744"
},
"flags": 0,
"description": "Allows user to specify defines for streaming job request."
@@ -34925,13 +35253,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1724"
+ "$ref": "#/1738"
},
{
- "$ref": "#/1725"
+ "$ref": "#/1739"
},
{
- "$ref": "#/1726"
+ "$ref": "#/1740"
},
{
"$ref": "#/2"
@@ -34968,7 +35296,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1733"
+ "$ref": "#/1747"
},
"flags": 1,
"description": "Lookup activity properties."
@@ -34982,14 +35310,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1734"
+ "$ref": "#/1748"
},
"flags": 1,
"description": "Type of activity."
@@ -35002,14 +35330,14 @@
"properties": {
"source": {
"type": {
- "$ref": "#/1137"
+ "$ref": "#/1146"
},
"flags": 1,
"description": "Dataset-specific source properties, same as copy activity source."
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 1,
"description": "Lookup activity dataset reference."
@@ -35033,7 +35361,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1736"
+ "$ref": "#/1750"
},
"flags": 1,
"description": "Script activity properties."
@@ -35047,14 +35375,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1762"
+ "$ref": "#/1776"
},
"flags": 1,
"description": "Type of activity."
@@ -35074,14 +35402,14 @@
},
"scripts": {
"type": {
- "$ref": "#/1757"
+ "$ref": "#/1771"
},
"flags": 0,
"description": "Array of script blocks. Type: array."
},
"logSettings": {
"type": {
- "$ref": "#/1758"
+ "$ref": "#/1772"
},
"flags": 0,
"description": "Log settings of script activity."
@@ -35115,7 +35443,7 @@
},
"parameters": {
"type": {
- "$ref": "#/1756"
+ "$ref": "#/1770"
},
"flags": 0,
"description": "Array of script parameters. Type: array."
@@ -35135,7 +35463,7 @@
},
"type": {
"type": {
- "$ref": "#/1751"
+ "$ref": "#/1765"
},
"flags": 0,
"description": "The type of the parameter."
@@ -35149,7 +35477,7 @@
},
"direction": {
"type": {
- "$ref": "#/1755"
+ "$ref": "#/1769"
},
"flags": 0,
"description": "The direction of the parameter."
@@ -35215,40 +35543,40 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1739"
+ "$ref": "#/1753"
},
{
- "$ref": "#/1740"
+ "$ref": "#/1754"
},
{
- "$ref": "#/1741"
+ "$ref": "#/1755"
},
{
- "$ref": "#/1742"
+ "$ref": "#/1756"
},
{
- "$ref": "#/1743"
+ "$ref": "#/1757"
},
{
- "$ref": "#/1744"
+ "$ref": "#/1758"
},
{
- "$ref": "#/1745"
+ "$ref": "#/1759"
},
{
- "$ref": "#/1746"
+ "$ref": "#/1760"
},
{
- "$ref": "#/1747"
+ "$ref": "#/1761"
},
{
- "$ref": "#/1748"
+ "$ref": "#/1762"
},
{
- "$ref": "#/1749"
+ "$ref": "#/1763"
},
{
- "$ref": "#/1750"
+ "$ref": "#/1764"
},
{
"$ref": "#/2"
@@ -35271,13 +35599,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1752"
+ "$ref": "#/1766"
},
{
- "$ref": "#/1753"
+ "$ref": "#/1767"
},
{
- "$ref": "#/1754"
+ "$ref": "#/1768"
},
{
"$ref": "#/2"
@@ -35287,13 +35615,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1738"
+ "$ref": "#/1752"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1737"
+ "$ref": "#/1751"
}
},
{
@@ -35302,14 +35630,14 @@
"properties": {
"logDestination": {
"type": {
- "$ref": "#/1761"
+ "$ref": "#/1775"
},
"flags": 1,
"description": "The destination of logs. Type: string."
},
"logLocationSettings": {
"type": {
- "$ref": "#/1581"
+ "$ref": "#/1595"
},
"flags": 0,
"description": "Log location settings customer needs to provide when enabling log."
@@ -35328,10 +35656,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1759"
+ "$ref": "#/1773"
},
{
- "$ref": "#/1760"
+ "$ref": "#/1774"
},
{
"$ref": "#/2"
@@ -35348,7 +35676,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1764"
+ "$ref": "#/1778"
},
"flags": 1,
"description": "Execute spark job activity properties."
@@ -35362,14 +35690,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1783"
+ "$ref": "#/1797"
},
"flags": 1,
"description": "Type of activity."
@@ -35382,14 +35710,14 @@
"properties": {
"sparkJob": {
"type": {
- "$ref": "#/1765"
+ "$ref": "#/1779"
},
"flags": 1,
"description": "Synapse spark job reference."
},
"args": {
"type": {
- "$ref": "#/1768"
+ "$ref": "#/1782"
},
"flags": 0,
"description": "User specified arguments to SynapseSparkJobDefinitionActivity."
@@ -35417,28 +35745,28 @@
},
"files": {
"type": {
- "$ref": "#/1769"
+ "$ref": "#/1783"
},
"flags": 0,
"description": "(Deprecated. Please use pythonCodeReference and filesV2) Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide."
},
"pythonCodeReference": {
"type": {
- "$ref": "#/1770"
+ "$ref": "#/1784"
},
"flags": 0,
"description": "Additional python code files used for reference in the main definition file, which will override the 'pyFiles' of the spark job definition you provide."
},
"filesV2": {
"type": {
- "$ref": "#/1771"
+ "$ref": "#/1785"
},
"flags": 0,
"description": "Additional files used for reference in the main definition file, which will override the 'jars' and 'files' of the spark job definition you provide."
},
"targetBigDataPool": {
"type": {
- "$ref": "#/1772"
+ "$ref": "#/1786"
},
"flags": 0,
"description": "The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide."
@@ -35473,21 +35801,21 @@
},
"configurationType": {
"type": {
- "$ref": "#/1778"
+ "$ref": "#/1792"
},
"flags": 0,
"description": "The type of the spark config."
},
"targetSparkConfiguration": {
"type": {
- "$ref": "#/1779"
+ "$ref": "#/1793"
},
"flags": 0,
"description": "The spark configuration of the spark job."
},
"sparkConfig": {
"type": {
- "$ref": "#/1782"
+ "$ref": "#/1796"
},
"flags": 0,
"description": "Spark configuration property."
@@ -35500,7 +35828,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1767"
+ "$ref": "#/1781"
},
"flags": 1,
"description": "Synapse spark job reference type."
@@ -35522,7 +35850,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1766"
+ "$ref": "#/1780"
},
{
"$ref": "#/2"
@@ -35559,7 +35887,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1774"
+ "$ref": "#/1788"
},
"flags": 1,
"description": "Big data pool reference type."
@@ -35581,7 +35909,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1773"
+ "$ref": "#/1787"
},
{
"$ref": "#/2"
@@ -35604,13 +35932,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1775"
+ "$ref": "#/1789"
},
{
- "$ref": "#/1776"
+ "$ref": "#/1790"
},
{
- "$ref": "#/1777"
+ "$ref": "#/1791"
},
{
"$ref": "#/2"
@@ -35623,7 +35951,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1781"
+ "$ref": "#/1795"
},
"flags": 1,
"description": "Spark configuration reference type."
@@ -35645,7 +35973,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1780"
+ "$ref": "#/1794"
},
{
"$ref": "#/2"
@@ -35670,7 +35998,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1785"
+ "$ref": "#/1799"
},
"flags": 1,
"description": "SQL stored procedure activity properties."
@@ -35684,14 +36012,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1786"
+ "$ref": "#/1800"
},
"flags": 1,
"description": "Type of activity."
@@ -35728,7 +36056,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1788"
+ "$ref": "#/1802"
},
"flags": 1,
"description": "Execute Synapse notebook activity properties."
@@ -35742,14 +36070,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1804"
+ "$ref": "#/1818"
},
"flags": 1,
"description": "Type of activity."
@@ -35762,21 +36090,21 @@
"properties": {
"notebook": {
"type": {
- "$ref": "#/1789"
+ "$ref": "#/1803"
},
"flags": 1,
"description": "Synapse notebook reference."
},
"sparkPool": {
"type": {
- "$ref": "#/1772"
+ "$ref": "#/1786"
},
"flags": 0,
"description": "The name of the big data pool which will be used to execute the notebook."
},
"parameters": {
"type": {
- "$ref": "#/1798"
+ "$ref": "#/1812"
},
"flags": 0,
"description": "Notebook parameters."
@@ -35811,21 +36139,21 @@
},
"configurationType": {
"type": {
- "$ref": "#/1802"
+ "$ref": "#/1816"
},
"flags": 0,
"description": "The type of the spark config."
},
"targetSparkConfiguration": {
"type": {
- "$ref": "#/1779"
+ "$ref": "#/1793"
},
"flags": 0,
"description": "The spark configuration of the spark job."
},
"sparkConfig": {
"type": {
- "$ref": "#/1803"
+ "$ref": "#/1817"
},
"flags": 0,
"description": "Spark configuration property."
@@ -35838,7 +36166,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1791"
+ "$ref": "#/1805"
},
"flags": 1,
"description": "Synapse notebook reference type."
@@ -35860,7 +36188,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1790"
+ "$ref": "#/1804"
},
{
"$ref": "#/2"
@@ -35880,7 +36208,7 @@
},
"type": {
"type": {
- "$ref": "#/1797"
+ "$ref": "#/1811"
},
"flags": 0,
"description": "Notebook parameter type."
@@ -35907,16 +36235,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1793"
+ "$ref": "#/1807"
},
{
- "$ref": "#/1794"
+ "$ref": "#/1808"
},
{
- "$ref": "#/1795"
+ "$ref": "#/1809"
},
{
- "$ref": "#/1796"
+ "$ref": "#/1810"
},
{
"$ref": "#/2"
@@ -35928,7 +36256,7 @@
"name": "SynapseNotebookActivityTypePropertiesParameters",
"properties": {},
"additionalProperties": {
- "$ref": "#/1792"
+ "$ref": "#/1806"
}
},
{
@@ -35947,13 +36275,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1799"
+ "$ref": "#/1813"
},
{
- "$ref": "#/1800"
+ "$ref": "#/1814"
},
{
- "$ref": "#/1801"
+ "$ref": "#/1815"
},
{
"$ref": "#/2"
@@ -35978,7 +36306,7 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1806"
+ "$ref": "#/1820"
},
"flags": 1,
"description": "Web activity properties."
@@ -35992,14 +36320,14 @@
},
"policy": {
"type": {
- "$ref": "#/1048"
+ "$ref": "#/1057"
},
"flags": 0,
"description": "Activity policy."
},
"type": {
"type": {
- "$ref": "#/1815"
+ "$ref": "#/1829"
},
"flags": 1,
"description": "Type of activity."
@@ -36012,7 +36340,7 @@
"properties": {
"method": {
"type": {
- "$ref": "#/1811"
+ "$ref": "#/1825"
},
"flags": 1,
"description": "Rest API method for target endpoint."
@@ -36026,7 +36354,7 @@
},
"headers": {
"type": {
- "$ref": "#/1812"
+ "$ref": "#/1826"
},
"flags": 0,
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)."
@@ -36040,7 +36368,7 @@
},
"authentication": {
"type": {
- "$ref": "#/1133"
+ "$ref": "#/1142"
},
"flags": 0,
"description": "Authentication method used for calling the endpoint."
@@ -36068,14 +36396,14 @@
},
"datasets": {
"type": {
- "$ref": "#/1813"
+ "$ref": "#/1827"
},
"flags": 0,
"description": "List of datasets passed to web endpoint."
},
"linkedServices": {
"type": {
- "$ref": "#/1814"
+ "$ref": "#/1828"
},
"flags": 0,
"description": "List of linked services passed to web endpoint."
@@ -36109,16 +36437,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1807"
+ "$ref": "#/1821"
},
{
- "$ref": "#/1808"
+ "$ref": "#/1822"
},
{
- "$ref": "#/1809"
+ "$ref": "#/1823"
},
{
- "$ref": "#/1810"
+ "$ref": "#/1824"
},
{
"$ref": "#/2"
@@ -36136,7 +36464,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
}
},
{
@@ -36152,7 +36480,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1025"
+ "$ref": "#/1034"
}
},
{
@@ -36169,7 +36497,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1822"
+ "$ref": "#/1836"
},
"flags": 1,
"description": "Variable type."
@@ -36199,13 +36527,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1819"
+ "$ref": "#/1833"
},
{
- "$ref": "#/1820"
+ "$ref": "#/1834"
},
{
- "$ref": "#/1821"
+ "$ref": "#/1835"
},
{
"$ref": "#/2"
@@ -36217,7 +36545,7 @@
"name": "VariableDefinitionSpecification",
"properties": {},
"additionalProperties": {
- "$ref": "#/1818"
+ "$ref": "#/1832"
}
},
{
@@ -36253,7 +36581,7 @@
"properties": {
"elapsedTimeMetric": {
"type": {
- "$ref": "#/1828"
+ "$ref": "#/1842"
},
"flags": 0,
"description": "Pipeline ElapsedTime Metric Policy."
@@ -36278,7 +36606,7 @@
"name": "Microsoft.DataFactory/factories/pipelines@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1023"
+ "$ref": "#/1032"
},
"flags": 0
},
@@ -36310,21 +36638,21 @@
},
"type": {
"type": {
- "$ref": "#/1830"
+ "$ref": "#/1844"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1831"
+ "$ref": "#/1845"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1833"
+ "$ref": "#/1847"
},
"flags": 1,
"description": "Properties of the trigger."
@@ -36352,14 +36680,14 @@
},
"runtimeState": {
"type": {
- "$ref": "#/1837"
+ "$ref": "#/1851"
},
"flags": 2,
"description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger."
},
"annotations": {
"type": {
- "$ref": "#/1838"
+ "$ref": "#/1852"
},
"flags": 0,
"description": "List of tags that can be used for describing the trigger."
@@ -36367,25 +36695,25 @@
},
"elements": {
"BlobEventsTrigger": {
- "$ref": "#/1839"
+ "$ref": "#/1853"
},
"BlobTrigger": {
- "$ref": "#/1849"
+ "$ref": "#/1863"
},
"ChainingTrigger": {
- "$ref": "#/1853"
+ "$ref": "#/1867"
},
"CustomEventsTrigger": {
- "$ref": "#/1857"
+ "$ref": "#/1871"
},
"ScheduleTrigger": {
- "$ref": "#/1862"
+ "$ref": "#/1876"
},
"RerunTumblingWindowTrigger": {
- "$ref": "#/1898"
+ "$ref": "#/1912"
},
"TumblingWindowTrigger": {
- "$ref": "#/1902"
+ "$ref": "#/1916"
}
}
},
@@ -36405,13 +36733,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1834"
+ "$ref": "#/1848"
},
{
- "$ref": "#/1835"
+ "$ref": "#/1849"
},
{
- "$ref": "#/1836"
+ "$ref": "#/1850"
},
{
"$ref": "#/2"
@@ -36430,21 +36758,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1840"
+ "$ref": "#/1854"
},
"flags": 1,
"description": "Blob Events Trigger properties."
},
"pipelines": {
"type": {
- "$ref": "#/1847"
+ "$ref": "#/1861"
},
"flags": 0,
"description": "Pipelines that need to be started."
},
"type": {
"type": {
- "$ref": "#/1848"
+ "$ref": "#/1862"
},
"flags": 1,
"description": "Trigger type."
@@ -36478,7 +36806,7 @@
},
"events": {
"type": {
- "$ref": "#/1844"
+ "$ref": "#/1858"
},
"flags": 1,
"description": "The type of events that cause this trigger to fire."
@@ -36504,10 +36832,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1841"
+ "$ref": "#/1855"
},
{
- "$ref": "#/1842"
+ "$ref": "#/1856"
},
{
"$ref": "#/2"
@@ -36517,7 +36845,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1843"
+ "$ref": "#/1857"
}
},
{
@@ -36526,14 +36854,14 @@
"properties": {
"pipelineReference": {
"type": {
- "$ref": "#/1079"
+ "$ref": "#/1088"
},
"flags": 0,
"description": "Pipeline reference."
},
"parameters": {
"type": {
- "$ref": "#/1846"
+ "$ref": "#/1860"
},
"flags": 0,
"description": "Pipeline parameters."
@@ -36551,7 +36879,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1845"
+ "$ref": "#/1859"
}
},
{
@@ -36564,21 +36892,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1850"
+ "$ref": "#/1864"
},
"flags": 1,
"description": "Blob Trigger properties."
},
"pipelines": {
"type": {
- "$ref": "#/1851"
+ "$ref": "#/1865"
},
"flags": 0,
"description": "Pipelines that need to be started."
},
"type": {
"type": {
- "$ref": "#/1852"
+ "$ref": "#/1866"
},
"flags": 1,
"description": "Trigger type."
@@ -36615,7 +36943,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1845"
+ "$ref": "#/1859"
}
},
{
@@ -36628,21 +36956,21 @@
"properties": {
"pipeline": {
"type": {
- "$ref": "#/1845"
+ "$ref": "#/1859"
},
"flags": 1,
"description": "Pipeline for which runs are created when all upstream pipelines complete successfully."
},
"typeProperties": {
"type": {
- "$ref": "#/1854"
+ "$ref": "#/1868"
},
"flags": 1,
"description": "Chaining Trigger properties."
},
"type": {
"type": {
- "$ref": "#/1856"
+ "$ref": "#/1870"
},
"flags": 1,
"description": "Trigger type."
@@ -36655,7 +36983,7 @@
"properties": {
"dependsOn": {
"type": {
- "$ref": "#/1855"
+ "$ref": "#/1869"
},
"flags": 1,
"description": "Upstream Pipelines."
@@ -36672,7 +37000,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1079"
+ "$ref": "#/1088"
}
},
{
@@ -36685,21 +37013,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1858"
+ "$ref": "#/1872"
},
"flags": 1,
"description": "Custom Events Trigger properties."
},
"pipelines": {
"type": {
- "$ref": "#/1860"
+ "$ref": "#/1874"
},
"flags": 0,
"description": "Pipelines that need to be started."
},
"type": {
"type": {
- "$ref": "#/1861"
+ "$ref": "#/1875"
},
"flags": 1,
"description": "Trigger type."
@@ -36726,7 +37054,7 @@
},
"events": {
"type": {
- "$ref": "#/1859"
+ "$ref": "#/1873"
},
"flags": 1,
"description": "The list of event types that cause this trigger to fire."
@@ -36749,7 +37077,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1845"
+ "$ref": "#/1859"
}
},
{
@@ -36762,21 +37090,21 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1863"
+ "$ref": "#/1877"
},
"flags": 1,
"description": "Schedule Trigger properties."
},
"pipelines": {
"type": {
- "$ref": "#/1896"
+ "$ref": "#/1910"
},
"flags": 0,
"description": "Pipelines that need to be started."
},
"type": {
"type": {
- "$ref": "#/1897"
+ "$ref": "#/1911"
},
"flags": 1,
"description": "Trigger type."
@@ -36789,7 +37117,7 @@
"properties": {
"recurrence": {
"type": {
- "$ref": "#/1864"
+ "$ref": "#/1878"
},
"flags": 1,
"description": "Recurrence schedule configuration."
@@ -36802,7 +37130,7 @@
"properties": {
"frequency": {
"type": {
- "$ref": "#/1872"
+ "$ref": "#/1886"
},
"flags": 0,
"description": "The frequency."
@@ -36837,7 +37165,7 @@
},
"schedule": {
"type": {
- "$ref": "#/1873"
+ "$ref": "#/1887"
},
"flags": 0,
"description": "The recurrence schedule."
@@ -36879,25 +37207,25 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1865"
+ "$ref": "#/1879"
},
{
- "$ref": "#/1866"
+ "$ref": "#/1880"
},
{
- "$ref": "#/1867"
+ "$ref": "#/1881"
},
{
- "$ref": "#/1868"
+ "$ref": "#/1882"
},
{
- "$ref": "#/1869"
+ "$ref": "#/1883"
},
{
- "$ref": "#/1870"
+ "$ref": "#/1884"
},
{
- "$ref": "#/1871"
+ "$ref": "#/1885"
},
{
"$ref": "#/2"
@@ -36910,35 +37238,35 @@
"properties": {
"minutes": {
"type": {
- "$ref": "#/1874"
+ "$ref": "#/1888"
},
"flags": 0,
"description": "The minutes."
},
"hours": {
"type": {
- "$ref": "#/1875"
+ "$ref": "#/1889"
},
"flags": 0,
"description": "The hours."
},
"weekDays": {
"type": {
- "$ref": "#/1884"
+ "$ref": "#/1898"
},
"flags": 0,
"description": "The days of the week."
},
"monthDays": {
"type": {
- "$ref": "#/1885"
+ "$ref": "#/1899"
},
"flags": 0,
"description": "The month days."
},
"monthlyOccurrences": {
"type": {
- "$ref": "#/1895"
+ "$ref": "#/1909"
},
"flags": 0,
"description": "The monthly occurrences."
@@ -36992,32 +37320,32 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1876"
+ "$ref": "#/1890"
},
{
- "$ref": "#/1877"
+ "$ref": "#/1891"
},
{
- "$ref": "#/1878"
+ "$ref": "#/1892"
},
{
- "$ref": "#/1879"
+ "$ref": "#/1893"
},
{
- "$ref": "#/1880"
+ "$ref": "#/1894"
},
{
- "$ref": "#/1881"
+ "$ref": "#/1895"
},
{
- "$ref": "#/1882"
+ "$ref": "#/1896"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1883"
+ "$ref": "#/1897"
}
},
{
@@ -37032,7 +37360,7 @@
"properties": {
"day": {
"type": {
- "$ref": "#/1894"
+ "$ref": "#/1908"
},
"flags": 0,
"description": "The day of the week."
@@ -37081,38 +37409,38 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1887"
+ "$ref": "#/1901"
},
{
- "$ref": "#/1888"
+ "$ref": "#/1902"
},
{
- "$ref": "#/1889"
+ "$ref": "#/1903"
},
{
- "$ref": "#/1890"
+ "$ref": "#/1904"
},
{
- "$ref": "#/1891"
+ "$ref": "#/1905"
},
{
- "$ref": "#/1892"
+ "$ref": "#/1906"
},
{
- "$ref": "#/1893"
+ "$ref": "#/1907"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1886"
+ "$ref": "#/1900"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1845"
+ "$ref": "#/1859"
}
},
{
@@ -37125,14 +37453,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1899"
+ "$ref": "#/1913"
},
"flags": 1,
"description": "Rerun Trigger properties."
},
"type": {
"type": {
- "$ref": "#/1901"
+ "$ref": "#/1915"
},
"flags": 1,
"description": "Trigger type."
@@ -37166,7 +37494,7 @@
},
"rerunConcurrency": {
"type": {
- "$ref": "#/1900"
+ "$ref": "#/1914"
},
"flags": 1,
"description": "The max number of parallel time windows (ready for execution) for which a rerun is triggered."
@@ -37188,21 +37516,21 @@
"properties": {
"pipeline": {
"type": {
- "$ref": "#/1845"
+ "$ref": "#/1859"
},
"flags": 1,
"description": "Pipeline for which runs are created when an event is fired for trigger window that is ready."
},
"typeProperties": {
"type": {
- "$ref": "#/1903"
+ "$ref": "#/1917"
},
"flags": 1,
"description": "Tumbling Window Trigger properties."
},
"type": {
"type": {
- "$ref": "#/1921"
+ "$ref": "#/1935"
},
"flags": 1,
"description": "Trigger type."
@@ -37215,7 +37543,7 @@
"properties": {
"frequency": {
"type": {
- "$ref": "#/1907"
+ "$ref": "#/1921"
},
"flags": 1,
"description": "The frequency of the time windows."
@@ -37250,21 +37578,21 @@
},
"maxConcurrency": {
"type": {
- "$ref": "#/1900"
+ "$ref": "#/1914"
},
"flags": 1,
"description": "The max number of parallel time windows (ready for execution) for which a new run is triggered."
},
"retryPolicy": {
"type": {
- "$ref": "#/1908"
+ "$ref": "#/1922"
},
"flags": 0,
"description": "Retry policy that will be applied for failed pipeline runs."
},
"dependsOn": {
"type": {
- "$ref": "#/1920"
+ "$ref": "#/1934"
},
"flags": 0,
"description": "Triggers that this trigger depends on. Only tumbling window triggers are supported."
@@ -37287,13 +37615,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1904"
+ "$ref": "#/1918"
},
{
- "$ref": "#/1905"
+ "$ref": "#/1919"
},
{
- "$ref": "#/1906"
+ "$ref": "#/1920"
},
{
"$ref": "#/2"
@@ -37313,7 +37641,7 @@
},
"intervalInSeconds": {
"type": {
- "$ref": "#/1049"
+ "$ref": "#/1058"
},
"flags": 0,
"description": "Interval between retries in seconds. Default is 30."
@@ -37327,10 +37655,10 @@
"baseProperties": {},
"elements": {
"SelfDependencyTumblingWindowTriggerReference": {
- "$ref": "#/1910"
+ "$ref": "#/1924"
},
"TumblingWindowTriggerDependencyReference": {
- "$ref": "#/1914"
+ "$ref": "#/1928"
}
}
},
@@ -37340,21 +37668,21 @@
"properties": {
"offset": {
"type": {
- "$ref": "#/1911"
+ "$ref": "#/1925"
},
"flags": 1,
"description": "Timespan applied to the start time of a tumbling window when evaluating dependency."
},
"size": {
"type": {
- "$ref": "#/1912"
+ "$ref": "#/1926"
},
"flags": 0,
"description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used."
},
"type": {
"type": {
- "$ref": "#/1913"
+ "$ref": "#/1927"
},
"flags": 1,
"description": "The type of dependency reference."
@@ -37383,28 +37711,28 @@
"properties": {
"offset": {
"type": {
- "$ref": "#/1915"
+ "$ref": "#/1929"
},
"flags": 0,
"description": "Timespan applied to the start time of a tumbling window when evaluating dependency."
},
"size": {
"type": {
- "$ref": "#/1912"
+ "$ref": "#/1926"
},
"flags": 0,
"description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used."
},
"referenceTrigger": {
"type": {
- "$ref": "#/1916"
+ "$ref": "#/1930"
},
"flags": 1,
"description": "Referenced trigger."
},
"type": {
"type": {
- "$ref": "#/1919"
+ "$ref": "#/1933"
},
"flags": 1,
"description": "The type of dependency reference."
@@ -37423,7 +37751,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/1918"
+ "$ref": "#/1932"
},
"flags": 1,
"description": "Trigger reference type."
@@ -37445,7 +37773,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/1917"
+ "$ref": "#/1931"
},
{
"$ref": "#/2"
@@ -37459,7 +37787,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1909"
+ "$ref": "#/1923"
}
},
{
@@ -37471,7 +37799,7 @@
"name": "Microsoft.DataFactory/factories/triggers@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1832"
+ "$ref": "#/1846"
},
"flags": 0
},
@@ -37503,21 +37831,21 @@
},
"type": {
"type": {
- "$ref": "#/1923"
+ "$ref": "#/1937"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1924"
+ "$ref": "#/1938"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1926"
+ "$ref": "#/1940"
},
"flags": 1,
"description": "Data flow properties."
@@ -37545,14 +37873,14 @@
},
"annotations": {
"type": {
- "$ref": "#/1927"
+ "$ref": "#/1941"
},
"flags": 0,
"description": "List of tags that can be used for describing the data flow."
},
"folder": {
"type": {
- "$ref": "#/1928"
+ "$ref": "#/1942"
},
"flags": 0,
"description": "The folder that this data flow is in. If not specified, Data flow will appear at the root level."
@@ -37560,13 +37888,13 @@
},
"elements": {
"Flowlet": {
- "$ref": "#/1929"
+ "$ref": "#/1943"
},
"MappingDataFlow": {
- "$ref": "#/1939"
+ "$ref": "#/1953"
},
"WranglingDataFlow": {
- "$ref": "#/1946"
+ "$ref": "#/1960"
}
}
},
@@ -37595,14 +37923,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1930"
+ "$ref": "#/1944"
},
"flags": 0,
"description": "Flowlet type properties."
},
"type": {
"type": {
- "$ref": "#/1938"
+ "$ref": "#/1952"
},
"flags": 1,
"description": "Type of data flow."
@@ -37615,21 +37943,21 @@
"properties": {
"sources": {
"type": {
- "$ref": "#/1932"
+ "$ref": "#/1946"
},
"flags": 0,
"description": "List of sources in Flowlet."
},
"sinks": {
"type": {
- "$ref": "#/1934"
+ "$ref": "#/1948"
},
"flags": 0,
"description": "List of sinks in Flowlet."
},
"transformations": {
"type": {
- "$ref": "#/1936"
+ "$ref": "#/1950"
},
"flags": 0,
"description": "List of transformations in Flowlet."
@@ -37643,7 +37971,7 @@
},
"scriptLines": {
"type": {
- "$ref": "#/1937"
+ "$ref": "#/1951"
},
"flags": 0,
"description": "Flowlet script lines."
@@ -37677,7 +38005,7 @@
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 0,
"description": "Dataset reference."
@@ -37691,7 +38019,7 @@
},
"flowlet": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 0,
"description": "Flowlet Reference"
@@ -37701,7 +38029,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1931"
+ "$ref": "#/1945"
}
},
{
@@ -37738,7 +38066,7 @@
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 0,
"description": "Dataset reference."
@@ -37752,7 +38080,7 @@
},
"flowlet": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 0,
"description": "Flowlet Reference"
@@ -37762,7 +38090,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1933"
+ "$ref": "#/1947"
}
},
{
@@ -37785,7 +38113,7 @@
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 0,
"description": "Dataset reference."
@@ -37799,7 +38127,7 @@
},
"flowlet": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 0,
"description": "Flowlet Reference"
@@ -37809,7 +38137,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1935"
+ "$ref": "#/1949"
}
},
{
@@ -37828,14 +38156,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1940"
+ "$ref": "#/1954"
},
"flags": 0,
"description": "Mapping data flow type properties."
},
"type": {
"type": {
- "$ref": "#/1945"
+ "$ref": "#/1959"
},
"flags": 1,
"description": "Type of data flow."
@@ -37848,21 +38176,21 @@
"properties": {
"sources": {
"type": {
- "$ref": "#/1941"
+ "$ref": "#/1955"
},
"flags": 0,
"description": "List of sources in data flow."
},
"sinks": {
"type": {
- "$ref": "#/1942"
+ "$ref": "#/1956"
},
"flags": 0,
"description": "List of sinks in data flow."
},
"transformations": {
"type": {
- "$ref": "#/1943"
+ "$ref": "#/1957"
},
"flags": 0,
"description": "List of transformations in data flow."
@@ -37876,7 +38204,7 @@
},
"scriptLines": {
"type": {
- "$ref": "#/1944"
+ "$ref": "#/1958"
},
"flags": 0,
"description": "Data flow script lines."
@@ -37886,19 +38214,19 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1931"
+ "$ref": "#/1945"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1933"
+ "$ref": "#/1947"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1935"
+ "$ref": "#/1949"
}
},
{
@@ -37917,14 +38245,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1947"
+ "$ref": "#/1961"
},
"flags": 0,
"description": "PowerQuery data flow type properties."
},
"type": {
"type": {
- "$ref": "#/1950"
+ "$ref": "#/1964"
},
"flags": 1,
"description": "Type of data flow."
@@ -37937,7 +38265,7 @@
"properties": {
"sources": {
"type": {
- "$ref": "#/1949"
+ "$ref": "#/1963"
},
"flags": 0,
"description": "List of sources in Power Query."
@@ -37992,7 +38320,7 @@
},
"dataset": {
"type": {
- "$ref": "#/1120"
+ "$ref": "#/1129"
},
"flags": 0,
"description": "Dataset reference."
@@ -38006,7 +38334,7 @@
},
"flowlet": {
"type": {
- "$ref": "#/1622"
+ "$ref": "#/1636"
},
"flags": 0,
"description": "Flowlet Reference"
@@ -38016,7 +38344,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1948"
+ "$ref": "#/1962"
}
},
{
@@ -38028,7 +38356,7 @@
"name": "Microsoft.DataFactory/factories/dataflows@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1925"
+ "$ref": "#/1939"
},
"flags": 0
},
@@ -38059,28 +38387,28 @@
},
"name": {
"type": {
- "$ref": "#/1952"
+ "$ref": "#/1966"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/1953"
+ "$ref": "#/1967"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1954"
+ "$ref": "#/1968"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1956"
+ "$ref": "#/1970"
},
"flags": 1,
"description": "Managed Virtual Network properties."
@@ -38122,7 +38450,7 @@
"name": "Microsoft.DataFactory/factories/managedVirtualNetworks@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1955"
+ "$ref": "#/1969"
},
"flags": 0
},
@@ -38147,28 +38475,28 @@
},
"name": {
"type": {
- "$ref": "#/1952"
+ "$ref": "#/1966"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/1958"
+ "$ref": "#/1972"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1959"
+ "$ref": "#/1973"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1961"
+ "$ref": "#/1975"
},
"flags": 1,
"description": "Managed private endpoint properties."
@@ -38188,14 +38516,14 @@
"properties": {
"connectionState": {
"type": {
- "$ref": "#/1962"
+ "$ref": "#/1976"
},
"flags": 0,
"description": "The managed private endpoint connection state"
},
"fqdns": {
"type": {
- "$ref": "#/1963"
+ "$ref": "#/1977"
},
"flags": 0,
"description": "Fully qualified domain names"
@@ -38271,7 +38599,7 @@
"name": "Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1960"
+ "$ref": "#/1974"
},
"flags": 0
},
@@ -38296,28 +38624,28 @@
},
"name": {
"type": {
- "$ref": "#/1952"
+ "$ref": "#/1966"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/1965"
+ "$ref": "#/1979"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1966"
+ "$ref": "#/1980"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1968"
+ "$ref": "#/1982"
},
"flags": 1,
"description": "Properties of credentials."
@@ -38345,7 +38673,7 @@
},
"annotations": {
"type": {
- "$ref": "#/1969"
+ "$ref": "#/1983"
},
"flags": 0,
"description": "List of tags that can be used for describing the Credential."
@@ -38353,10 +38681,10 @@
},
"elements": {
"ManagedIdentity": {
- "$ref": "#/1970"
+ "$ref": "#/1984"
},
"ServicePrincipal": {
- "$ref": "#/1973"
+ "$ref": "#/1987"
}
}
},
@@ -38372,14 +38700,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1971"
+ "$ref": "#/1985"
},
"flags": 0,
"description": "Managed identity credential properties."
},
"type": {
"type": {
- "$ref": "#/1972"
+ "$ref": "#/1986"
},
"flags": 1,
"description": "Type of credential."
@@ -38409,14 +38737,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/1974"
+ "$ref": "#/1988"
},
"flags": 1,
"description": "Service Principal credential properties."
},
"type": {
"type": {
- "$ref": "#/1975"
+ "$ref": "#/1989"
},
"flags": 1,
"description": "Type of credential."
@@ -38436,7 +38764,7 @@
},
"servicePrincipalKey": {
"type": {
- "$ref": "#/196"
+ "$ref": "#/198"
},
"flags": 0,
"description": "The key of the service principal used to authenticate."
@@ -38459,7 +38787,7 @@
"name": "Microsoft.DataFactory/factories/credentials@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1967"
+ "$ref": "#/1981"
},
"flags": 0
},
@@ -38491,21 +38819,21 @@
},
"type": {
"type": {
- "$ref": "#/1977"
+ "$ref": "#/1991"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1978"
+ "$ref": "#/1992"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1980"
+ "$ref": "#/1994"
},
"flags": 0,
"description": "Core resource properties"
@@ -38525,14 +38853,14 @@
"properties": {
"privateLinkServiceConnectionState": {
"type": {
- "$ref": "#/1981"
+ "$ref": "#/1995"
},
"flags": 0,
"description": "The state of a private link connection"
},
"privateEndpoint": {
"type": {
- "$ref": "#/1982"
+ "$ref": "#/1996"
},
"flags": 0,
"description": "The resource of private endpoint."
@@ -38590,7 +38918,7 @@
"name": "Microsoft.DataFactory/factories/privateEndpointConnections@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1979"
+ "$ref": "#/1993"
},
"flags": 0
},
@@ -38622,21 +38950,21 @@
},
"type": {
"type": {
- "$ref": "#/1984"
+ "$ref": "#/1998"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1985"
+ "$ref": "#/1999"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1987"
+ "$ref": "#/2001"
},
"flags": 1,
"description": "Properties of the global parameter."
@@ -38663,7 +38991,7 @@
"name": "Microsoft.DataFactory/factories/globalParameters@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1986"
+ "$ref": "#/2000"
},
"flags": 0
},
@@ -38695,21 +39023,21 @@
},
"type": {
"type": {
- "$ref": "#/1989"
+ "$ref": "#/2003"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/1990"
+ "$ref": "#/2004"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/1992"
+ "$ref": "#/2006"
},
"flags": 1,
"description": "Properties of the change data capture."
@@ -38729,7 +39057,7 @@
"properties": {
"folder": {
"type": {
- "$ref": "#/1993"
+ "$ref": "#/2007"
},
"flags": 0,
"description": "The folder that this CDC is in. If not specified, CDC will appear at the root level."
@@ -38743,21 +39071,21 @@
},
"sourceConnectionsInfo": {
"type": {
- "$ref": "#/2006"
+ "$ref": "#/2020"
},
"flags": 1,
"description": "List of sources connections that can be used as sources in the CDC."
},
"targetConnectionsInfo": {
"type": {
- "$ref": "#/2024"
+ "$ref": "#/2038"
},
"flags": 1,
"description": "List of target connections that can be used as sources in the CDC."
},
"policy": {
"type": {
- "$ref": "#/2025"
+ "$ref": "#/2039"
},
"flags": 1,
"description": "CDC policy"
@@ -38797,14 +39125,14 @@
"properties": {
"sourceEntities": {
"type": {
- "$ref": "#/2001"
+ "$ref": "#/2015"
},
"flags": 0,
"description": "List of source tables for a source connection."
},
"connection": {
"type": {
- "$ref": "#/2002"
+ "$ref": "#/2016"
},
"flags": 0,
"description": "Source connection details."
@@ -38824,7 +39152,7 @@
},
"properties": {
"type": {
- "$ref": "#/1996"
+ "$ref": "#/2010"
},
"flags": 0,
"description": "Table properties."
@@ -38837,14 +39165,14 @@
"properties": {
"schema": {
"type": {
- "$ref": "#/1998"
+ "$ref": "#/2012"
},
"flags": 0,
"description": "List of columns for the source table."
},
"dslConnectorProperties": {
"type": {
- "$ref": "#/2000"
+ "$ref": "#/2014"
},
"flags": 0,
"description": "List of name/value pairs for connection properties."
@@ -38874,7 +39202,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1997"
+ "$ref": "#/2011"
}
},
{
@@ -38900,13 +39228,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1999"
+ "$ref": "#/2013"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1995"
+ "$ref": "#/2009"
}
},
{
@@ -38929,7 +39257,7 @@
},
"type": {
"type": {
- "$ref": "#/2004"
+ "$ref": "#/2018"
},
"flags": 1,
"description": "Type of connection via linked service or dataset."
@@ -38943,7 +39271,7 @@
},
"commonDslConnectorProperties": {
"type": {
- "$ref": "#/2005"
+ "$ref": "#/2019"
},
"flags": 0,
"description": "List of name/value pairs for connection properties."
@@ -38958,7 +39286,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2003"
+ "$ref": "#/2017"
},
{
"$ref": "#/2"
@@ -38968,13 +39296,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1999"
+ "$ref": "#/2013"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1994"
+ "$ref": "#/2008"
}
},
{
@@ -38983,28 +39311,28 @@
"properties": {
"targetEntities": {
"type": {
- "$ref": "#/2008"
+ "$ref": "#/2022"
},
"flags": 0,
"description": "List of source tables for a target connection."
},
"connection": {
"type": {
- "$ref": "#/2002"
+ "$ref": "#/2016"
},
"flags": 0,
"description": "Source connection details."
},
"dataMapperMappings": {
"type": {
- "$ref": "#/2022"
+ "$ref": "#/2036"
},
"flags": 0,
"description": "List of table mappings."
},
"relationships": {
"type": {
- "$ref": "#/2023"
+ "$ref": "#/2037"
},
"flags": 0,
"description": "List of relationship info among the tables."
@@ -39014,7 +39342,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/1995"
+ "$ref": "#/2009"
}
},
{
@@ -39037,14 +39365,14 @@
},
"sourceConnectionReference": {
"type": {
- "$ref": "#/2010"
+ "$ref": "#/2024"
},
"flags": 0,
"description": "The connection reference for the source connection."
},
"attributeMappingInfo": {
"type": {
- "$ref": "#/2013"
+ "$ref": "#/2027"
},
"flags": 0,
"description": "This holds the user provided attribute mapping information."
@@ -39071,7 +39399,7 @@
},
"type": {
"type": {
- "$ref": "#/2012"
+ "$ref": "#/2026"
},
"flags": 0,
"description": "Type of connection via linked service or dataset."
@@ -39086,7 +39414,7 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2011"
+ "$ref": "#/2025"
},
{
"$ref": "#/2"
@@ -39099,7 +39427,7 @@
"properties": {
"attributeMappings": {
"type": {
- "$ref": "#/2021"
+ "$ref": "#/2035"
},
"flags": 0,
"description": "List of attribute mappings."
@@ -39119,7 +39447,7 @@
},
"type": {
"type": {
- "$ref": "#/2018"
+ "$ref": "#/2032"
},
"flags": 0,
"description": "Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'."
@@ -39140,14 +39468,14 @@
},
"attributeReference": {
"type": {
- "$ref": "#/2019"
+ "$ref": "#/2033"
},
"flags": 0,
"description": "Reference of the source column used in the mapping. It is used for 'Direct' mapping type only."
},
"attributeReferences": {
"type": {
- "$ref": "#/2020"
+ "$ref": "#/2034"
},
"flags": 0,
"description": "List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only."
@@ -39170,13 +39498,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2015"
+ "$ref": "#/2029"
},
{
- "$ref": "#/2016"
+ "$ref": "#/2030"
},
{
- "$ref": "#/2017"
+ "$ref": "#/2031"
},
{
"$ref": "#/2"
@@ -39203,7 +39531,7 @@
},
"entityConnectionReference": {
"type": {
- "$ref": "#/2010"
+ "$ref": "#/2024"
},
"flags": 0,
"description": "The connection reference for the connection."
@@ -39213,19 +39541,19 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2019"
+ "$ref": "#/2033"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2014"
+ "$ref": "#/2028"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2009"
+ "$ref": "#/2023"
}
},
{
@@ -39237,7 +39565,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2007"
+ "$ref": "#/2021"
}
},
{
@@ -39253,7 +39581,7 @@
},
"recurrence": {
"type": {
- "$ref": "#/2026"
+ "$ref": "#/2040"
},
"flags": 0,
"description": "Defines the frequency and interval for running the CDC for batch mode."
@@ -39266,7 +39594,7 @@
"properties": {
"frequency": {
"type": {
- "$ref": "#/2030"
+ "$ref": "#/2044"
},
"flags": 0,
"description": "Frequency of period in terms of 'Hour', 'Minute' or 'Second'."
@@ -39296,13 +39624,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2027"
+ "$ref": "#/2041"
},
{
- "$ref": "#/2028"
+ "$ref": "#/2042"
},
{
- "$ref": "#/2029"
+ "$ref": "#/2043"
},
{
"$ref": "#/2"
@@ -39314,7 +39642,7 @@
"name": "Microsoft.DataFactory/factories/adfcdcs@2018-06-01",
"scopeType": 8,
"body": {
- "$ref": "#/1991"
+ "$ref": "#/2005"
},
"flags": 0
},
@@ -39386,7 +39714,7 @@
},
"tags": {
"type": {
- "$ref": "#/2034"
+ "$ref": "#/2048"
},
"flags": 0,
"description": "The resource tags."
@@ -39417,10 +39745,10 @@
"resourceType": "Microsoft.DataFactory/locations",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2033"
+ "$ref": "#/2047"
},
"input": {
- "$ref": "#/2032"
+ "$ref": "#/2046"
}
},
{
@@ -39469,10 +39797,10 @@
"resourceType": "Microsoft.DataFactory/locations",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2037"
+ "$ref": "#/2051"
},
"input": {
- "$ref": "#/2036"
+ "$ref": "#/2050"
}
},
{
@@ -39528,10 +39856,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2040"
+ "$ref": "#/2054"
},
"input": {
- "$ref": "#/2039"
+ "$ref": "#/2053"
}
},
{
@@ -39581,7 +39909,7 @@
"properties": {
"policy": {
"type": {
- "$ref": "#/2042"
+ "$ref": "#/2056"
},
"flags": 0,
"description": "The user access policy."
@@ -39608,10 +39936,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2043"
+ "$ref": "#/2057"
},
"input": {
- "$ref": "#/2042"
+ "$ref": "#/2056"
}
},
{
@@ -39620,10 +39948,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2037"
+ "$ref": "#/2051"
},
"input": {
- "$ref": "#/2036"
+ "$ref": "#/2050"
}
},
{
@@ -39632,7 +39960,7 @@
"properties": {
"exposureControlRequests": {
"type": {
- "$ref": "#/2047"
+ "$ref": "#/2061"
},
"flags": 1,
"description": "List of exposure control features."
@@ -39642,7 +39970,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2036"
+ "$ref": "#/2050"
}
},
{
@@ -39651,7 +39979,7 @@
"properties": {
"exposureControlResponses": {
"type": {
- "$ref": "#/2049"
+ "$ref": "#/2063"
},
"flags": 1,
"description": "List of exposure control feature values."
@@ -39661,7 +39989,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2037"
+ "$ref": "#/2051"
}
},
{
@@ -39670,10 +39998,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2048"
+ "$ref": "#/2062"
},
"input": {
- "$ref": "#/2046"
+ "$ref": "#/2060"
}
},
{
@@ -39703,14 +40031,14 @@
},
"filters": {
"type": {
- "$ref": "#/2072"
+ "$ref": "#/2086"
},
"flags": 0,
"description": "List of filters."
},
"orderBy": {
"type": {
- "$ref": "#/2087"
+ "$ref": "#/2101"
},
"flags": 0,
"description": "List of OrderBy option."
@@ -39723,21 +40051,21 @@
"properties": {
"operand": {
"type": {
- "$ref": "#/2065"
+ "$ref": "#/2079"
},
"flags": 1,
"description": "Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status."
},
"operator": {
"type": {
- "$ref": "#/2070"
+ "$ref": "#/2084"
},
"flags": 1,
"description": "Operator to be used for filter."
},
"values": {
"type": {
- "$ref": "#/2071"
+ "$ref": "#/2085"
},
"flags": 1,
"description": "List of filter values."
@@ -39796,40 +40124,40 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2053"
+ "$ref": "#/2067"
},
{
- "$ref": "#/2054"
+ "$ref": "#/2068"
},
{
- "$ref": "#/2055"
+ "$ref": "#/2069"
},
{
- "$ref": "#/2056"
+ "$ref": "#/2070"
},
{
- "$ref": "#/2057"
+ "$ref": "#/2071"
},
{
- "$ref": "#/2058"
+ "$ref": "#/2072"
},
{
- "$ref": "#/2059"
+ "$ref": "#/2073"
},
{
- "$ref": "#/2060"
+ "$ref": "#/2074"
},
{
- "$ref": "#/2061"
+ "$ref": "#/2075"
},
{
- "$ref": "#/2062"
+ "$ref": "#/2076"
},
{
- "$ref": "#/2063"
+ "$ref": "#/2077"
},
{
- "$ref": "#/2064"
+ "$ref": "#/2078"
},
{
"$ref": "#/2"
@@ -39856,16 +40184,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2066"
+ "$ref": "#/2080"
},
{
- "$ref": "#/2067"
+ "$ref": "#/2081"
},
{
- "$ref": "#/2068"
+ "$ref": "#/2082"
},
{
- "$ref": "#/2069"
+ "$ref": "#/2083"
},
{
"$ref": "#/2"
@@ -39881,7 +40209,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2052"
+ "$ref": "#/2066"
}
},
{
@@ -39890,14 +40218,14 @@
"properties": {
"orderBy": {
"type": {
- "$ref": "#/2083"
+ "$ref": "#/2097"
},
"flags": 1,
"description": "Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status."
},
"order": {
"type": {
- "$ref": "#/2086"
+ "$ref": "#/2100"
},
"flags": 1,
"description": "Sorting order of the parameter."
@@ -39944,31 +40272,31 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2074"
+ "$ref": "#/2088"
},
{
- "$ref": "#/2075"
+ "$ref": "#/2089"
},
{
- "$ref": "#/2076"
+ "$ref": "#/2090"
},
{
- "$ref": "#/2077"
+ "$ref": "#/2091"
},
{
- "$ref": "#/2078"
+ "$ref": "#/2092"
},
{
- "$ref": "#/2079"
+ "$ref": "#/2093"
},
{
- "$ref": "#/2080"
+ "$ref": "#/2094"
},
{
- "$ref": "#/2081"
+ "$ref": "#/2095"
},
{
- "$ref": "#/2082"
+ "$ref": "#/2096"
},
{
"$ref": "#/2"
@@ -39987,10 +40315,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2084"
+ "$ref": "#/2098"
},
{
- "$ref": "#/2085"
+ "$ref": "#/2099"
},
{
"$ref": "#/2"
@@ -40000,7 +40328,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2073"
+ "$ref": "#/2087"
}
},
{
@@ -40009,7 +40337,7 @@
"properties": {
"value": {
"type": {
- "$ref": "#/2093"
+ "$ref": "#/2107"
},
"flags": 1,
"description": "List of pipeline runs."
@@ -40057,21 +40385,21 @@
},
"parameters": {
"type": {
- "$ref": "#/2090"
+ "$ref": "#/2104"
},
"flags": 2,
"description": "The full or partial list of parameter name, value pair used in the pipeline run."
},
"runDimensions": {
"type": {
- "$ref": "#/2091"
+ "$ref": "#/2105"
},
"flags": 2,
"description": "Run dimensions emitted by Pipeline run."
},
"invokedBy": {
"type": {
- "$ref": "#/2092"
+ "$ref": "#/2106"
},
"flags": 2,
"description": "Entity that started the pipeline run."
@@ -40183,7 +40511,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2089"
+ "$ref": "#/2103"
}
},
{
@@ -40192,10 +40520,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2088"
+ "$ref": "#/2102"
},
"input": {
- "$ref": "#/2051"
+ "$ref": "#/2065"
}
},
{
@@ -40224,7 +40552,7 @@
"properties": {
"value": {
"type": {
- "$ref": "#/2098"
+ "$ref": "#/2112"
},
"flags": 1,
"description": "List of triggers."
@@ -40244,7 +40572,7 @@
"properties": {
"properties": {
"type": {
- "$ref": "#/1833"
+ "$ref": "#/1847"
},
"flags": 1,
"description": "Properties of the trigger."
@@ -40282,7 +40610,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2097"
+ "$ref": "#/2111"
}
},
{
@@ -40291,10 +40619,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2096"
+ "$ref": "#/2110"
},
"input": {
- "$ref": "#/2095"
+ "$ref": "#/2109"
}
},
{
@@ -40303,7 +40631,7 @@
"properties": {
"value": {
"type": {
- "$ref": "#/2110"
+ "$ref": "#/2124"
},
"flags": 1,
"description": "List of trigger runs."
@@ -40351,7 +40679,7 @@
},
"status": {
"type": {
- "$ref": "#/2105"
+ "$ref": "#/2119"
},
"flags": 2,
"description": "Trigger run status."
@@ -40365,28 +40693,28 @@
},
"properties": {
"type": {
- "$ref": "#/2106"
+ "$ref": "#/2120"
},
"flags": 2,
"description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger."
},
"triggeredPipelines": {
"type": {
- "$ref": "#/2107"
+ "$ref": "#/2121"
},
"flags": 2,
"description": "List of pipeline name and run Id triggered by the trigger run."
},
"runDimension": {
"type": {
- "$ref": "#/2108"
+ "$ref": "#/2122"
},
"flags": 2,
"description": "Run dimension for which trigger was fired."
},
"dependencyStatus": {
"type": {
- "$ref": "#/2109"
+ "$ref": "#/2123"
},
"flags": 2,
"description": "Status of the upstream pipelines."
@@ -40412,13 +40740,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2102"
+ "$ref": "#/2116"
},
{
- "$ref": "#/2103"
+ "$ref": "#/2117"
},
{
- "$ref": "#/2104"
+ "$ref": "#/2118"
},
{
"$ref": "#/2"
@@ -40460,7 +40788,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2101"
+ "$ref": "#/2115"
}
},
{
@@ -40469,10 +40797,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2100"
+ "$ref": "#/2114"
},
"input": {
- "$ref": "#/2051"
+ "$ref": "#/2065"
}
},
{
@@ -40502,7 +40830,7 @@
},
"integrationRuntime": {
"type": {
- "$ref": "#/2113"
+ "$ref": "#/2127"
},
"flags": 0,
"description": "Set to use integration runtime setting for data flow debug session."
@@ -40555,10 +40883,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2114"
+ "$ref": "#/2128"
},
"input": {
- "$ref": "#/2112"
+ "$ref": "#/2126"
}
},
{
@@ -40567,7 +40895,7 @@
"properties": {
"value": {
"type": {
- "$ref": "#/2118"
+ "$ref": "#/2132"
},
"flags": 0,
"description": "Array with all active debug sessions."
@@ -40656,7 +40984,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2117"
+ "$ref": "#/2131"
}
},
{
@@ -40665,7 +40993,7 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2116"
+ "$ref": "#/2130"
}
},
{
@@ -40681,42 +41009,42 @@
},
"dataFlow": {
"type": {
- "$ref": "#/2121"
+ "$ref": "#/2135"
},
"flags": 0,
"description": "Data flow instance."
},
"dataFlows": {
"type": {
- "$ref": "#/2122"
+ "$ref": "#/2136"
},
"flags": 0,
"description": "List of Data flows"
},
"datasets": {
"type": {
- "$ref": "#/2124"
+ "$ref": "#/2138"
},
"flags": 0,
"description": "List of datasets."
},
"linkedServices": {
"type": {
- "$ref": "#/2126"
+ "$ref": "#/2140"
},
"flags": 0,
"description": "List of linked services."
},
"staging": {
"type": {
- "$ref": "#/1626"
+ "$ref": "#/1640"
},
"flags": 0,
"description": "Staging info for debug session."
},
"debugSettings": {
"type": {
- "$ref": "#/2127"
+ "$ref": "#/2141"
},
"flags": 0,
"description": "Data flow debug settings."
@@ -40732,7 +41060,7 @@
"properties": {
"properties": {
"type": {
- "$ref": "#/1926"
+ "$ref": "#/1940"
},
"flags": 1,
"description": "Data flow properties."
@@ -40749,7 +41077,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2121"
+ "$ref": "#/2135"
}
},
{
@@ -40758,7 +41086,7 @@
"properties": {
"properties": {
"type": {
- "$ref": "#/682"
+ "$ref": "#/687"
},
"flags": 1,
"description": "Dataset properties."
@@ -40775,7 +41103,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2123"
+ "$ref": "#/2137"
}
},
{
@@ -40801,7 +41129,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2125"
+ "$ref": "#/2139"
}
},
{
@@ -40810,14 +41138,14 @@
"properties": {
"sourceSettings": {
"type": {
- "$ref": "#/2129"
+ "$ref": "#/2143"
},
"flags": 0,
"description": "Source setting for data flow debug."
},
"parameters": {
"type": {
- "$ref": "#/2130"
+ "$ref": "#/2144"
},
"flags": 0,
"description": "Data flow parameters."
@@ -40857,7 +41185,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2128"
+ "$ref": "#/2142"
}
},
{
@@ -40887,10 +41215,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2131"
+ "$ref": "#/2145"
},
"input": {
- "$ref": "#/2120"
+ "$ref": "#/2134"
}
},
{
@@ -40912,7 +41240,7 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"input": {
- "$ref": "#/2133"
+ "$ref": "#/2147"
}
},
{
@@ -40928,14 +41256,14 @@
},
"command": {
"type": {
- "$ref": "#/2139"
+ "$ref": "#/2153"
},
"flags": 0,
"description": "The command type."
},
"commandPayload": {
"type": {
- "$ref": "#/2140"
+ "$ref": "#/2154"
},
"flags": 0,
"description": "The command payload object."
@@ -40958,13 +41286,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2136"
+ "$ref": "#/2150"
},
{
- "$ref": "#/2137"
+ "$ref": "#/2151"
},
{
- "$ref": "#/2138"
+ "$ref": "#/2152"
},
{
"$ref": "#/2"
@@ -40991,7 +41319,7 @@
},
"columns": {
"type": {
- "$ref": "#/2141"
+ "$ref": "#/2155"
},
"flags": 0,
"description": "Array of column names."
@@ -41037,10 +41365,10 @@
"resourceType": "Microsoft.DataFactory/factories",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2142"
+ "$ref": "#/2156"
},
"input": {
- "$ref": "#/2135"
+ "$ref": "#/2149"
}
},
{
@@ -41056,7 +41384,7 @@
},
"properties": {
"type": {
- "$ref": "#/2145"
+ "$ref": "#/2159"
},
"flags": 1,
"description": "Integration runtime properties."
@@ -41077,7 +41405,7 @@
},
"state": {
"type": {
- "$ref": "#/2156"
+ "$ref": "#/2170"
},
"flags": 2,
"description": "The state of integration runtime."
@@ -41085,10 +41413,10 @@
},
"elements": {
"Managed": {
- "$ref": "#/2157"
+ "$ref": "#/2171"
},
"SelfHosted": {
- "$ref": "#/2173"
+ "$ref": "#/2187"
}
}
},
@@ -41136,34 +41464,34 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2146"
+ "$ref": "#/2160"
},
{
- "$ref": "#/2147"
+ "$ref": "#/2161"
},
{
- "$ref": "#/2148"
+ "$ref": "#/2162"
},
{
- "$ref": "#/2149"
+ "$ref": "#/2163"
},
{
- "$ref": "#/2150"
+ "$ref": "#/2164"
},
{
- "$ref": "#/2151"
+ "$ref": "#/2165"
},
{
- "$ref": "#/2152"
+ "$ref": "#/2166"
},
{
- "$ref": "#/2153"
+ "$ref": "#/2167"
},
{
- "$ref": "#/2154"
+ "$ref": "#/2168"
},
{
- "$ref": "#/2155"
+ "$ref": "#/2169"
},
{
"$ref": "#/2"
@@ -41176,14 +41504,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/2158"
+ "$ref": "#/2172"
},
"flags": 1,
"description": "Managed integration runtime status type properties."
},
"type": {
"type": {
- "$ref": "#/2172"
+ "$ref": "#/2186"
},
"flags": 1,
"description": "Type of integration runtime."
@@ -41203,21 +41531,21 @@
},
"nodes": {
"type": {
- "$ref": "#/2168"
+ "$ref": "#/2182"
},
"flags": 2,
"description": "The list of nodes for managed integration runtime."
},
"otherErrors": {
"type": {
- "$ref": "#/2169"
+ "$ref": "#/2183"
},
"flags": 2,
"description": "The errors that occurred on this integration runtime."
},
"lastOperation": {
"type": {
- "$ref": "#/2170"
+ "$ref": "#/2184"
},
"flags": 2,
"description": "The last operation result that occurred on this integration runtime."
@@ -41237,14 +41565,14 @@
},
"status": {
"type": {
- "$ref": "#/2164"
+ "$ref": "#/2178"
},
"flags": 2,
"description": "The managed integration runtime node status."
},
"errors": {
"type": {
- "$ref": "#/2167"
+ "$ref": "#/2181"
},
"flags": 0,
"description": "The errors that occurred on this integration runtime node."
@@ -41274,16 +41602,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2160"
+ "$ref": "#/2174"
},
{
- "$ref": "#/2161"
+ "$ref": "#/2175"
},
{
- "$ref": "#/2162"
+ "$ref": "#/2176"
},
{
- "$ref": "#/2163"
+ "$ref": "#/2177"
},
{
"$ref": "#/2"
@@ -41310,7 +41638,7 @@
},
"parameters": {
"type": {
- "$ref": "#/2166"
+ "$ref": "#/2180"
},
"flags": 2,
"description": "Managed integration runtime error parameters."
@@ -41336,19 +41664,19 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2165"
+ "$ref": "#/2179"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2159"
+ "$ref": "#/2173"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2165"
+ "$ref": "#/2179"
}
},
{
@@ -41385,7 +41713,7 @@
},
"parameters": {
"type": {
- "$ref": "#/2171"
+ "$ref": "#/2185"
},
"flags": 2,
"description": "Managed integration runtime error parameters."
@@ -41418,14 +41746,14 @@
"properties": {
"typeProperties": {
"type": {
- "$ref": "#/2174"
+ "$ref": "#/2188"
},
"flags": 1,
"description": "Self-hosted integration runtime status type properties."
},
"type": {
"type": {
- "$ref": "#/2201"
+ "$ref": "#/2215"
},
"flags": 1,
"description": "Type of integration runtime."
@@ -41452,7 +41780,7 @@
},
"internalChannelEncryption": {
"type": {
- "$ref": "#/2178"
+ "$ref": "#/2192"
},
"flags": 2,
"description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist)."
@@ -41466,7 +41794,7 @@
},
"nodes": {
"type": {
- "$ref": "#/2193"
+ "$ref": "#/2207"
},
"flags": 0,
"description": "The list of nodes for this integration runtime."
@@ -41494,21 +41822,21 @@
},
"capabilities": {
"type": {
- "$ref": "#/2194"
+ "$ref": "#/2208"
},
"flags": 2,
"description": "Object with additional information about integration runtime capabilities."
},
"serviceUrls": {
"type": {
- "$ref": "#/2195"
+ "$ref": "#/2209"
},
"flags": 2,
"description": "The URLs for the services used in integration runtime backend service."
},
"autoUpdate": {
"type": {
- "$ref": "#/2198"
+ "$ref": "#/2212"
},
"flags": 2,
"description": "Whether Self-hosted integration runtime auto update has been turned on."
@@ -41522,7 +41850,7 @@
},
"links": {
"type": {
- "$ref": "#/2200"
+ "$ref": "#/2214"
},
"flags": 0,
"description": "The list of linked integration runtimes that are created to share with this integration runtime."
@@ -41573,13 +41901,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2175"
+ "$ref": "#/2189"
},
{
- "$ref": "#/2176"
+ "$ref": "#/2190"
},
{
- "$ref": "#/2177"
+ "$ref": "#/2191"
},
{
"$ref": "#/2"
@@ -41613,14 +41941,14 @@
},
"status": {
"type": {
- "$ref": "#/2187"
+ "$ref": "#/2201"
},
"flags": 2,
"description": "Status of the integration runtime node."
},
"capabilities": {
"type": {
- "$ref": "#/2188"
+ "$ref": "#/2202"
},
"flags": 2,
"description": "The integration runtime capabilities dictionary"
@@ -41676,7 +42004,7 @@
},
"lastUpdateResult": {
"type": {
- "$ref": "#/2192"
+ "$ref": "#/2206"
},
"flags": 2,
"description": "The result of the last integration runtime node update."
@@ -41753,25 +42081,25 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2180"
+ "$ref": "#/2194"
},
{
- "$ref": "#/2181"
+ "$ref": "#/2195"
},
{
- "$ref": "#/2182"
+ "$ref": "#/2196"
},
{
- "$ref": "#/2183"
+ "$ref": "#/2197"
},
{
- "$ref": "#/2184"
+ "$ref": "#/2198"
},
{
- "$ref": "#/2185"
+ "$ref": "#/2199"
},
{
- "$ref": "#/2186"
+ "$ref": "#/2200"
},
{
"$ref": "#/2"
@@ -41802,13 +42130,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2189"
+ "$ref": "#/2203"
},
{
- "$ref": "#/2190"
+ "$ref": "#/2204"
},
{
- "$ref": "#/2191"
+ "$ref": "#/2205"
},
{
"$ref": "#/2"
@@ -41818,7 +42146,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2179"
+ "$ref": "#/2193"
}
},
{
@@ -41847,10 +42175,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2196"
+ "$ref": "#/2210"
},
{
- "$ref": "#/2197"
+ "$ref": "#/2211"
},
{
"$ref": "#/2"
@@ -41901,7 +42229,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2199"
+ "$ref": "#/2213"
}
},
{
@@ -41914,7 +42242,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2144"
+ "$ref": "#/2158"
}
},
{
@@ -41974,7 +42302,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2203"
+ "$ref": "#/2217"
}
},
{
@@ -41983,7 +42311,7 @@
"properties": {
"keyName": {
"type": {
- "$ref": "#/2208"
+ "$ref": "#/2222"
},
"flags": 0,
"description": "The name of the authentication key to regenerate."
@@ -42002,10 +42330,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2206"
+ "$ref": "#/2220"
},
{
- "$ref": "#/2207"
+ "$ref": "#/2221"
},
{
"$ref": "#/2"
@@ -42038,10 +42366,10 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2209"
+ "$ref": "#/2223"
},
"input": {
- "$ref": "#/2205"
+ "$ref": "#/2219"
}
},
{
@@ -42050,7 +42378,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2209"
+ "$ref": "#/2223"
}
},
{
@@ -42059,7 +42387,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2144"
+ "$ref": "#/2158"
}
},
{
@@ -42087,7 +42415,7 @@
},
"nodes": {
"type": {
- "$ref": "#/2217"
+ "$ref": "#/2231"
},
"flags": 0,
"description": "Integration runtime node monitoring data."
@@ -42162,7 +42490,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2216"
+ "$ref": "#/2230"
}
},
{
@@ -42171,7 +42499,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2215"
+ "$ref": "#/2229"
}
},
{
@@ -42199,7 +42527,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"input": {
- "$ref": "#/2220"
+ "$ref": "#/2234"
}
},
{
@@ -42242,10 +42570,10 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2144"
+ "$ref": "#/2158"
},
"input": {
- "$ref": "#/2222"
+ "$ref": "#/2236"
}
},
{
@@ -42288,7 +42616,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2224"
+ "$ref": "#/2238"
}
},
{
@@ -42310,7 +42638,7 @@
"properties": {
"value": {
"type": {
- "$ref": "#/2244"
+ "$ref": "#/2258"
},
"flags": 0,
"description": "List of SSIS object metadata."
@@ -42353,16 +42681,16 @@
},
"elements": {
"Environment": {
- "$ref": "#/2229"
+ "$ref": "#/2243"
},
"Folder": {
- "$ref": "#/2233"
+ "$ref": "#/2247"
},
"Package": {
- "$ref": "#/2235"
+ "$ref": "#/2249"
},
"Project": {
- "$ref": "#/2239"
+ "$ref": "#/2253"
}
}
},
@@ -42379,14 +42707,14 @@
},
"variables": {
"type": {
- "$ref": "#/2231"
+ "$ref": "#/2245"
},
"flags": 0,
"description": "Variable in environment"
},
"type": {
"type": {
- "$ref": "#/2232"
+ "$ref": "#/2246"
},
"flags": 1,
"description": "Type of metadata."
@@ -42451,7 +42779,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2230"
+ "$ref": "#/2244"
}
},
{
@@ -42464,7 +42792,7 @@
"properties": {
"type": {
"type": {
- "$ref": "#/2234"
+ "$ref": "#/2248"
},
"flags": 1,
"description": "Type of metadata."
@@ -42502,14 +42830,14 @@
},
"parameters": {
"type": {
- "$ref": "#/2237"
+ "$ref": "#/2251"
},
"flags": 0,
"description": "Parameters in package"
},
"type": {
"type": {
- "$ref": "#/2238"
+ "$ref": "#/2252"
},
"flags": 1,
"description": "Type of metadata."
@@ -42609,7 +42937,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2236"
+ "$ref": "#/2250"
}
},
{
@@ -42636,21 +42964,21 @@
},
"environmentRefs": {
"type": {
- "$ref": "#/2241"
+ "$ref": "#/2255"
},
"flags": 0,
"description": "Environment reference in project"
},
"parameters": {
"type": {
- "$ref": "#/2242"
+ "$ref": "#/2256"
},
"flags": 0,
"description": "Parameters in project"
},
"type": {
"type": {
- "$ref": "#/2243"
+ "$ref": "#/2257"
},
"flags": 1,
"description": "Type of metadata."
@@ -42694,13 +43022,13 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2240"
+ "$ref": "#/2254"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2236"
+ "$ref": "#/2250"
}
},
{
@@ -42710,7 +43038,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2228"
+ "$ref": "#/2242"
}
},
{
@@ -42719,10 +43047,10 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2227"
+ "$ref": "#/2241"
},
"input": {
- "$ref": "#/2226"
+ "$ref": "#/2240"
}
},
{
@@ -42744,7 +43072,7 @@
"resourceType": "Microsoft.DataFactory/factories/integrationRuntimes/nodes",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2246"
+ "$ref": "#/2260"
}
},
{
@@ -42774,10 +43102,10 @@
"resourceType": "Microsoft.DataFactory/factories/pipelines",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2249"
+ "$ref": "#/2263"
},
"input": {
- "$ref": "#/2248"
+ "$ref": "#/2262"
}
},
{
@@ -42792,7 +43120,7 @@
"properties": {
"value": {
"type": {
- "$ref": "#/2254"
+ "$ref": "#/2268"
},
"flags": 1,
"description": "List of activity runs."
@@ -42909,7 +43237,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/2253"
+ "$ref": "#/2267"
}
},
{
@@ -42918,10 +43246,10 @@
"resourceType": "Microsoft.DataFactory/factories/pipelineruns",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2252"
+ "$ref": "#/2266"
},
"input": {
- "$ref": "#/2051"
+ "$ref": "#/2065"
}
},
{
@@ -42937,7 +43265,7 @@
},
"status": {
"type": {
- "$ref": "#/2262"
+ "$ref": "#/2276"
},
"flags": 2,
"description": "Event Subscription Status."
@@ -42968,19 +43296,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/2257"
+ "$ref": "#/2271"
},
{
- "$ref": "#/2258"
+ "$ref": "#/2272"
},
{
- "$ref": "#/2259"
+ "$ref": "#/2273"
},
{
- "$ref": "#/2260"
+ "$ref": "#/2274"
},
{
- "$ref": "#/2261"
+ "$ref": "#/2275"
},
{
"$ref": "#/2"
@@ -42993,7 +43321,7 @@
"resourceType": "Microsoft.DataFactory/factories/triggers",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2256"
+ "$ref": "#/2270"
}
},
{
@@ -43002,7 +43330,7 @@
"resourceType": "Microsoft.DataFactory/factories/triggers",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2256"
+ "$ref": "#/2270"
}
},
{
@@ -43011,7 +43339,7 @@
"resourceType": "Microsoft.DataFactory/factories/triggers",
"apiVersion": "2018-06-01",
"output": {
- "$ref": "#/2256"
+ "$ref": "#/2270"
}
},
{
diff --git a/internal/azure/generated/datamigration/microsoft.datamigration/2025-03-15-preview/types.json b/internal/azure/generated/datamigration/microsoft.datamigration/2025-03-15-preview/types.json
new file mode 100644
index 000000000..c0de3aa5a
--- /dev/null
+++ b/internal/azure/generated/datamigration/microsoft.datamigration/2025-03-15-preview/types.json
@@ -0,0 +1,18272 @@
+[
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/databaseMigrations"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/databaseMigrations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Database Migration Resource properties for CosmosDb for Mongo."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseMigrationPropertiesCosmosDbMongo",
+ "properties": {
+ "sourceMongoConnection": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Source Mongo connection details."
+ },
+ "targetMongoConnection": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Target Cosmos DB Mongo connection details."
+ },
+ "collectionList": {
+ "type": {
+ "$ref": "#/18"
+ },
+ "flags": 0,
+ "description": "List of Mongo Collections to be migrated."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 1
+ },
+ "scope": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource Id of the target resource."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 2,
+ "description": "Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started."
+ },
+ "migrationStatus": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration status."
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database migration start time."
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database migration end time."
+ },
+ "migrationService": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource Id of the Migration Service."
+ },
+ "migrationOperationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "ID for current migration operation."
+ },
+ "migrationFailureError": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 2,
+ "description": "Error details in case of migration failure."
+ },
+ "provisioningError": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error message for migration provisioning failure, if any."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoConnectionInformation",
+ "properties": {
+ "host": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Host of mongo connection."
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Port of mongo connection."
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 4,
+ "description": "User name to connect to Mongo."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 4,
+ "description": "Password to connect to Mongo."
+ },
+ "useSsl": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 4,
+ "description": "Whether to UseSsl or UseTls to connect to Mongo. Default is true."
+ },
+ "connectionString": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 4,
+ "description": "ConnectionString to connect to Mongo."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoMigrationCollection",
+ "properties": {
+ "sourceDatabase": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Source database name."
+ },
+ "sourceCollection": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Source collection name."
+ },
+ "targetDatabase": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Target database name."
+ },
+ "targetCollection": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Target collection name."
+ },
+ "migrationProgressDetails": {
+ "type": {
+ "$ref": "#/11"
+ },
+ "flags": 2,
+ "description": "Detailed migration status. Not included by default."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoMigrationProgressDetails",
+ "properties": {
+ "migrationStatus": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 2,
+ "description": "Migration Status"
+ },
+ "migrationError": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration Error"
+ },
+ "sourceDocumentCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Source Document Count"
+ },
+ "processedDocumentCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Processed Document Count"
+ },
+ "durationInSeconds": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Migration duration"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/15"
+ },
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/10"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlMi"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlVm"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlDb"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoToCosmosDbMongo"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/26"
+ },
+ {
+ "$ref": "#/27"
+ },
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ErrorInfo",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Error code."
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Error message."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/36"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/41"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/32"
+ },
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/35"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/databaseMigrations@2025-03-15-preview",
+ "scopeType": 16,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/migrationServices"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/migrationServices",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/43"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "The Migration Service properties."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/31"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationServiceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 2,
+ "description": "Provisioning state to track the async operation status."
+ },
+ "integrationRuntimeState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Current state of the Integration runtime."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/51"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/migrationServices@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/45"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/sqlMigrationServices"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/sqlMigrationServices",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/56"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 0,
+ "description": "The SQL Migration Service properties."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/59"
+ },
+ "flags": 0,
+ "description": "Dictionary of "
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlMigrationServiceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Provisioning state to track the async operation status."
+ },
+ "integrationRuntimeState": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Current state of the Integration runtime."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemDataAutoGenerated",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/61"
+ },
+ {
+ "$ref": "#/62"
+ },
+ {
+ "$ref": "#/63"
+ },
+ {
+ "$ref": "#/64"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/sqlMigrationServices@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/57"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/services"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/services",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/72"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "HTTP strong entity tag value. Ignored if submitted"
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource kind. Only 'vm' (the default) is supported."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/75"
+ },
+ "flags": 0,
+ "description": "Custom service properties"
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "Service SKU"
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "Dictionary of "
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataMigrationServiceProperties",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 2,
+ "description": "The resource's provisioning state"
+ },
+ "publicKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The public key of the service, used to encrypt secrets sent to the service"
+ },
+ "virtualSubnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined"
+ },
+ "virtualNicId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ID of the Microsoft.Network/networkInterfaces resource which the service have"
+ },
+ "autoStopDelay": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The time delay before the service is auto-stopped when idle."
+ },
+ "deleteResourcesOnStop": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether service resources should be deleted when stopped. (Turned on by default)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deploying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopping"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Starting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FailedToStart"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FailedToStop"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/79"
+ },
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/81"
+ },
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/85"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServiceSku",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The unique name of the SKU, such as 'P3'"
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'"
+ },
+ "family": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines"
+ },
+ "size": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines"
+ },
+ "capacity": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The capacity of the SKU, if it supports scaling"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/services@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/74"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/services/projects/tasks"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/services/projects/tasks",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "HTTP strong entity tag value. This is ignored if submitted."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Custom task properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "ProjectTaskProperties",
+ "discriminator": "taskType",
+ "baseProperties": {
+ "errors": {
+ "type": {
+ "$ref": "#/96"
+ },
+ "flags": 2,
+ "description": "Array of errors. This is ignored if submitted."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 2,
+ "description": "The state of the task. This is ignored if submitted."
+ },
+ "commands": {
+ "type": {
+ "$ref": "#/133"
+ },
+ "flags": 2,
+ "description": "Array of command properties."
+ },
+ "clientData": {
+ "type": {
+ "$ref": "#/134"
+ },
+ "flags": 0,
+ "description": "Key value pairs of client data to attach meta data information to task"
+ }
+ },
+ "elements": {
+ "Connect.MongoDb": {
+ "$ref": "#/135"
+ },
+ "ConnectToSource.MySql": {
+ "$ref": "#/161"
+ },
+ "ConnectToSource.Oracle.Sync": {
+ "$ref": "#/185"
+ },
+ "ConnectToSource.PostgreSql.Sync": {
+ "$ref": "#/199"
+ },
+ "ConnectToSource.SqlServer": {
+ "$ref": "#/213"
+ },
+ "ConnectToSource.SqlServer.Sync": {
+ "$ref": "#/279"
+ },
+ "ConnectToTarget.AzureDbForMySql": {
+ "$ref": "#/282"
+ },
+ "ConnectToTarget.AzureDbForPostgreSql.Sync": {
+ "$ref": "#/289"
+ },
+ "ConnectToTarget.AzureSqlDbMI": {
+ "$ref": "#/296"
+ },
+ "ConnectToTarget.AzureSqlDbMI.Sync.LRS": {
+ "$ref": "#/304"
+ },
+ "ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync": {
+ "$ref": "#/312"
+ },
+ "ConnectToTarget.SqlDb": {
+ "$ref": "#/322"
+ },
+ "ConnectToTarget.SqlDb.Sync": {
+ "$ref": "#/327"
+ },
+ "GetTDECertificates.Sql": {
+ "$ref": "#/331"
+ },
+ "GetUserTables.AzureSqlDb.Sync": {
+ "$ref": "#/340"
+ },
+ "GetUserTables.Sql": {
+ "$ref": "#/348"
+ },
+ "GetUserTablesMySql": {
+ "$ref": "#/355"
+ },
+ "GetUserTablesOracle": {
+ "$ref": "#/362"
+ },
+ "GetUserTablesPostgreSql": {
+ "$ref": "#/371"
+ },
+ "Migrate.MongoDb": {
+ "$ref": "#/379"
+ },
+ "Migrate.MySql.AzureDbForMySql": {
+ "$ref": "#/458"
+ },
+ "Migrate.MySql.AzureDbForMySql.Sync": {
+ "$ref": "#/512"
+ },
+ "Migrate.Oracle.AzureDbForPostgreSql.Sync": {
+ "$ref": "#/561"
+ },
+ "Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2": {
+ "$ref": "#/609"
+ },
+ "Migrate.SqlServer.AzureSqlDb.Sync": {
+ "$ref": "#/687"
+ },
+ "Migrate.SqlServer.AzureSqlDbMI": {
+ "$ref": "#/736"
+ },
+ "Migrate.SqlServer.AzureSqlDbMI.Sync.LRS": {
+ "$ref": "#/826"
+ },
+ "Migrate.SqlServer.SqlDb": {
+ "$ref": "#/878"
+ },
+ "Migrate.Ssis": {
+ "$ref": "#/1001"
+ },
+ "MigrateSchemaSqlServerSqlDb": {
+ "$ref": "#/1050"
+ },
+ "Service.Check.OCI": {
+ "$ref": "#/1097"
+ },
+ "Service.Install.OCI": {
+ "$ref": "#/1105"
+ },
+ "Service.Upload.OCI": {
+ "$ref": "#/1111"
+ },
+ "Validate.MongoDb": {
+ "$ref": "#/1117"
+ },
+ "Validate.Oracle.AzureDbPostgreSql.Sync": {
+ "$ref": "#/1139"
+ },
+ "ValidateMigrationInput.SqlServer.AzureSqlDbMI": {
+ "$ref": "#/1144"
+ },
+ "ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS": {
+ "$ref": "#/1169"
+ },
+ "ValidateMigrationInput.SqlServer.SqlDb.Sync": {
+ "$ref": "#/1176"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ODataError",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError'"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The human-readable description of the error"
+ },
+ "details": {
+ "type": {
+ "$ref": "#/95"
+ },
+ "flags": 0,
+ "description": "Inner errors that caused this error"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/94"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/94"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Queued"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FailedInputValidation"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Faulted"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/97"
+ },
+ {
+ "$ref": "#/98"
+ },
+ {
+ "$ref": "#/99"
+ },
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/103"
+ },
+ {
+ "$ref": "#/104"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "CommandProperties",
+ "discriminator": "commandType",
+ "baseProperties": {
+ "errors": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 2,
+ "description": "Array of errors. This is ignored if submitted."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/113"
+ },
+ "flags": 2,
+ "description": "The state of the command. This is ignored if submitted."
+ }
+ },
+ "elements": {
+ "Migrate.SqlServer.AzureDbSqlMi.Complete": {
+ "$ref": "#/114"
+ },
+ "Migrate.Sync.Complete.Database": {
+ "$ref": "#/120"
+ },
+ "cancel": {
+ "$ref": "#/125"
+ },
+ "finish": {
+ "$ref": "#/128"
+ },
+ "restart": {
+ "$ref": "#/131"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/94"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/108"
+ },
+ {
+ "$ref": "#/109"
+ },
+ {
+ "$ref": "#/110"
+ },
+ {
+ "$ref": "#/111"
+ },
+ {
+ "$ref": "#/112"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMISyncCompleteCommandProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 0,
+ "description": "Command input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 2,
+ "description": "Command output. This is ignored if submitted."
+ },
+ "commandType": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 1,
+ "description": "Command type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMISyncCompleteCommandInput",
+ "properties": {
+ "sourceDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of managed instance database"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMISyncCompleteCommandOutput",
+ "properties": {
+ "errors": {
+ "type": {
+ "$ref": "#/118"
+ },
+ "flags": 0,
+ "description": "List of errors that happened during the command execution"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ReportableException",
+ "properties": {
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error message"
+ },
+ "actionableMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Actionable steps for this exception"
+ },
+ "filePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The path to the file where exception occurred"
+ },
+ "lineNumber": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The line number where exception occurred"
+ },
+ "hResult": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Coded numerical value that is assigned to a specific exception"
+ },
+ "stackTrace": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Stack trace"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.SqlServer.AzureDbSqlMi.Complete"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSyncCompleteCommandProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "Command input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 2,
+ "description": "Command output. This is ignored if submitted."
+ },
+ "commandId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Command id"
+ },
+ "commandType": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 1,
+ "description": "Command type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSyncCompleteCommandInput",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of database"
+ },
+ "commitTimeStamp": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Time stamp to complete"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSyncCompleteCommandOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "errors": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 2,
+ "description": "List of errors that happened during the command execution"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.Sync.Complete.Database"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbCancelCommand",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Command input"
+ },
+ "commandType": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 1,
+ "description": "Command type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbCommandInput",
+ "properties": {
+ "objectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The qualified name of a database or collection to act upon, or null to act upon the entire migration"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "cancel"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbFinishCommand",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/129"
+ },
+ "flags": 0,
+ "description": "Command input"
+ },
+ "commandType": {
+ "type": {
+ "$ref": "#/130"
+ },
+ "flags": 1,
+ "description": "Command type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbFinishCommandInput",
+ "properties": {
+ "immediate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication."
+ },
+ "objectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The qualified name of a database or collection to act upon, or null to act upon the entire migration"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "finish"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbRestartCommand",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Command input"
+ },
+ "commandType": {
+ "type": {
+ "$ref": "#/132"
+ },
+ "flags": 1,
+ "description": "Command type."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "restart"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/106"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProjectTaskPropertiesClientData",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToMongoDbTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 0,
+ "description": "Describes a connection to a MongoDB data source"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/159"
+ },
+ "flags": 2,
+ "description": "An array containing a single MongoDbClusterInfo object"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/160"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbConnectionInfo",
+ "properties": {
+ "connectionString": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties"
+ },
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data source"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "serverBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server brand version"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "name of the server"
+ },
+ "trustServerCertificate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to trust the server certificate"
+ },
+ "enforceSSL": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "port for server"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/142"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/137"
+ },
+ {
+ "$ref": "#/138"
+ },
+ {
+ "$ref": "#/139"
+ },
+ {
+ "$ref": "#/140"
+ },
+ {
+ "$ref": "#/141"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbClusterInfo",
+ "properties": {
+ "databases": {
+ "type": {
+ "$ref": "#/154"
+ },
+ "flags": 1,
+ "description": "A list of non-system databases in the cluster"
+ },
+ "supportsSharding": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the cluster supports sharded collections"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/158"
+ },
+ "flags": 1,
+ "description": "The type of data source"
+ },
+ "version": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseInfo",
+ "properties": {
+ "collections": {
+ "type": {
+ "$ref": "#/153"
+ },
+ "flags": 1,
+ "description": "A list of supported collections in a MongoDB database"
+ },
+ "supportsSharding": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary."
+ },
+ "averageDocumentSize": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The average document size, or -1 if the average size is unknown"
+ },
+ "dataSize": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The estimated total data size, in bytes, or -1 if the size is unknown."
+ },
+ "documentCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The estimated total number of documents, or -1 if the document count is unknown"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The unqualified name of the database or collection"
+ },
+ "qualifiedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The qualified name of the database or collection. For a collection, this is the database-qualified name."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbCollectionInfo",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the database containing the collection"
+ },
+ "isCapped": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer)"
+ },
+ "isSystemCollection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the collection is system collection"
+ },
+ "isView": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the collection is a view of another collection"
+ },
+ "shardKey": {
+ "type": {
+ "$ref": "#/146"
+ },
+ "flags": 0,
+ "description": "The shard key on the collection, or null if the collection is not sharded"
+ },
+ "supportsSharding": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary."
+ },
+ "viewOf": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the collection that this is a view of, if IsView is true"
+ },
+ "averageDocumentSize": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The average document size, or -1 if the average size is unknown"
+ },
+ "dataSize": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The estimated total data size, in bytes, or -1 if the size is unknown."
+ },
+ "documentCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The estimated total number of documents, or -1 if the document count is unknown"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The unqualified name of the database or collection"
+ },
+ "qualifiedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The qualified name of the database or collection. For a collection, this is the database-qualified name."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbShardKeyInfo",
+ "properties": {
+ "fields": {
+ "type": {
+ "$ref": "#/152"
+ },
+ "flags": 1,
+ "description": "The fields within the shard key"
+ },
+ "isUnique": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 1,
+ "description": "Whether the shard key is unique"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbShardKeyField",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the field"
+ },
+ "order": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 1,
+ "description": "The field ordering"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Forward"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Reverse"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hashed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/148"
+ },
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/147"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/145"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/144"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BlobContainer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CosmosDb"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDb"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ },
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/143"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Connect.MongoDb"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceMySqlTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/162"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/184"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceMySqlTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Information for connecting to MySQL source"
+ },
+ "targetPlatform": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 0,
+ "description": "Target Platform for the migration"
+ },
+ "checkPermissionsGroup": {
+ "type": {
+ "$ref": "#/178"
+ },
+ "flags": 0,
+ "description": "Permission group for validations"
+ },
+ "isOfflineMigration": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether or not the migration is offline"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MySqlConnectionInfo",
+ "properties": {
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the server"
+ },
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data source"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "Port for Server"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/169"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/164"
+ },
+ {
+ "$ref": "#/165"
+ },
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlServer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureDbForMySQL"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/170"
+ },
+ {
+ "$ref": "#/171"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromSqlServerToAzureDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromSqlServerToAzureMI"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromMySQLToAzureDBForMySQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromSqlServerToAzureVM"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/173"
+ },
+ {
+ "$ref": "#/174"
+ },
+ {
+ "$ref": "#/175"
+ },
+ {
+ "$ref": "#/176"
+ },
+ {
+ "$ref": "#/177"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceNonSqlTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Server brand version"
+ },
+ "serverProperties": {
+ "type": {
+ "$ref": "#/180"
+ },
+ "flags": 2,
+ "description": "Server properties"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 2,
+ "description": "List of databases on the server"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/182"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ServerProperties",
+ "properties": {
+ "serverPlatform": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the server platform"
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the server"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the database server"
+ },
+ "serverEdition": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Edition of the database server"
+ },
+ "serverOperatingSystemVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the operating system"
+ },
+ "serverDatabaseCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of databases in the server"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/179"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToSource.MySql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceOracleSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/186"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/197"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/198"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceOracleSyncTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 1,
+ "description": "Information for connecting to Oracle source"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OracleConnectionInfo",
+ "properties": {
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "EZConnect or TNSName connection string."
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "name of the server"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "port for server"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/193"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/188"
+ },
+ {
+ "$ref": "#/189"
+ },
+ {
+ "$ref": "#/190"
+ },
+ {
+ "$ref": "#/191"
+ },
+ {
+ "$ref": "#/192"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceOracleSyncTaskOutput",
+ "properties": {
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the source server"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/195"
+ },
+ "flags": 2,
+ "description": "List of schemas on source server"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/194"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToSource.Oracle.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourcePostgreSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/212"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourcePostgreSqlSyncTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for source PostgreSQL server"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PostgreSqlConnectionInfo",
+ "properties": {
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the server"
+ },
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data source"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "Port for Server"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "trustServerCertificate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to trust the server certificate"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "serverBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server brand version"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/207"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/202"
+ },
+ {
+ "$ref": "#/203"
+ },
+ {
+ "$ref": "#/204"
+ },
+ {
+ "$ref": "#/205"
+ },
+ {
+ "$ref": "#/206"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourcePostgreSqlSyncTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the source server"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/209"
+ },
+ "flags": 2,
+ "description": "List of databases on source server"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/210"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/208"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToSource.PostgreSql.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Task id"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/278"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for Source SQL Server"
+ },
+ "checkPermissionsGroup": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "Permission group for validations"
+ },
+ "collectDatabases": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to collect databases from source server."
+ },
+ "collectLogins": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to collect logins from source server."
+ },
+ "collectAgentJobs": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to collect agent jobs from source server."
+ },
+ "collectTdeCertificateInfo": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to collect TDE Certificate names from source server."
+ },
+ "validateSsisCatalogOnly": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to validate SSIS catalog is reachable on the source server."
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlConnectionInfo",
+ "properties": {
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Data source in the format Protocol:MachineName\\SQLServerInstanceName,PortNumber"
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "name of the server"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Port for Server"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "serverBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server brand version"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Represents the ID of an HTTP resource represented by an Azure resource provider."
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/221"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "trustServerCertificate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to trust the server certificate"
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Server platform type for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/216"
+ },
+ {
+ "$ref": "#/217"
+ },
+ {
+ "$ref": "#/218"
+ },
+ {
+ "$ref": "#/219"
+ },
+ {
+ "$ref": "#/220"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlOnPrem"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/222"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromSqlServerToAzureDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromSqlServerToAzureMI"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromMySQLToAzureDBForMySQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationFromSqlServerToAzureVM"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/224"
+ },
+ {
+ "$ref": "#/225"
+ },
+ {
+ "$ref": "#/226"
+ },
+ {
+ "$ref": "#/227"
+ },
+ {
+ "$ref": "#/228"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "ConnectToSourceSqlServerTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "AgentJobLevelOutput": {
+ "$ref": "#/231"
+ },
+ "DatabaseLevelOutput": {
+ "$ref": "#/236"
+ },
+ "LoginLevelOutput": {
+ "$ref": "#/264"
+ },
+ "TaskLevelOutput": {
+ "$ref": "#/274"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerTaskOutputAgentJobLevel",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Agent Job name"
+ },
+ "jobCategory": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of Agent Job."
+ },
+ "isEnabled": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "The state of the original Agent Job."
+ },
+ "jobOwner": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The owner of the Agent Job"
+ },
+ "lastExecutedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "UTC Date and time when the Agent Job was last executed."
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ },
+ "migrationEligibility": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 2,
+ "description": "Information about eligibility of agent job for migration."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 1,
+ "description": "Type of result - database level or task level"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationEligibilityInfo",
+ "properties": {
+ "isEligibleForMigration": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Whether object is eligible for migration or not."
+ },
+ "validationMessages": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 2,
+ "description": "Information about eligibility failure for the server object."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AgentJobLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerTaskOutputDatabaseLevel",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database name"
+ },
+ "sizeMB": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Size of the file in megabytes"
+ },
+ "databaseFiles": {
+ "type": {
+ "$ref": "#/244"
+ },
+ "flags": 2,
+ "description": "The list of database files"
+ },
+ "compatibilityLevel": {
+ "type": {
+ "$ref": "#/252"
+ },
+ "flags": 2,
+ "description": "SQL Server compatibility level of database"
+ },
+ "databaseState": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 2,
+ "description": "State of the database"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 1,
+ "description": "Type of result - database level or task level"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseFileInfo",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Unique identifier for database file"
+ },
+ "logicalName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Logical name of the file"
+ },
+ "physicalFullName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Operating-system full path of the file"
+ },
+ "restoreFullName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Suggested full path of the file for restoring"
+ },
+ "fileType": {
+ "type": {
+ "$ref": "#/243"
+ },
+ "flags": 0,
+ "description": "Database file type"
+ },
+ "sizeMB": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Size of the file in megabytes"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rows"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Log"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Filestream"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotSupported"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fulltext"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/238"
+ },
+ {
+ "$ref": "#/239"
+ },
+ {
+ "$ref": "#/240"
+ },
+ {
+ "$ref": "#/241"
+ },
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/237"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel80"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel90"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel100"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel110"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel120"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel130"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompatLevel140"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/245"
+ },
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/248"
+ },
+ {
+ "$ref": "#/249"
+ },
+ {
+ "$ref": "#/250"
+ },
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Online"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restoring"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Recovering"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RecoveryPending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Suspect"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Emergency"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Offline"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OfflineSecondary"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/253"
+ },
+ {
+ "$ref": "#/254"
+ },
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/257"
+ },
+ {
+ "$ref": "#/258"
+ },
+ {
+ "$ref": "#/259"
+ },
+ {
+ "$ref": "#/260"
+ },
+ {
+ "$ref": "#/261"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerTaskOutputLoginLevel",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Login name."
+ },
+ "loginType": {
+ "type": {
+ "$ref": "#/272"
+ },
+ "flags": 2,
+ "description": "The type of login."
+ },
+ "defaultDatabase": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The default database for the login."
+ },
+ "isEnabled": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "The state of the login."
+ },
+ "migrationEligibility": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 2,
+ "description": "Information about eligibility of login for migration."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/273"
+ },
+ "flags": 1,
+ "description": "Type of result - database level or task level"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsUser"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsGroup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlLogin"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Certificate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AsymmetricKey"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ExternalUser"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ExternalGroup"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/266"
+ },
+ {
+ "$ref": "#/267"
+ },
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/269"
+ },
+ {
+ "$ref": "#/270"
+ },
+ {
+ "$ref": "#/271"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LoginLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerTaskOutputTaskLevel",
+ "properties": {
+ "databases": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source databases as a map from database name to database id"
+ },
+ "logins": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source logins as a map from login name to login id."
+ },
+ "agentJobs": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source agent jobs as a map from agent job name to id."
+ },
+ "databaseTdeCertificateMapping": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from database name to TDE certificate name, if applicable"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/276"
+ },
+ "flags": 1,
+ "description": "Type of result - database level or task level"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TaskLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/230"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToSource.SqlServer"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToSourceSqlServerSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/280"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/281"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/230"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToSource.SqlServer.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetAzureDbForMySqlTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetAzureDbForMySqlTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for source MySQL server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for MySQL server"
+ },
+ "isOfflineMigration": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether or not the migration is offline"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetAzureDbForMySqlTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the target server"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 2,
+ "description": "List of databases on target server"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/284"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.AzureDbForMySql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/294"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/295"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetAzureDbForPostgreSqlSyncTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for source PostgreSQL server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for PostgreSQL server"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the target server"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 2,
+ "description": "List of databases on target server"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/291"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.AzureDbForPostgreSql.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlMITaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlMITaskInput",
+ "properties": {
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for target SQL Server"
+ },
+ "collectLogins": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to collect logins from target SQL MI server."
+ },
+ "collectAgentJobs": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to collect agent jobs from target SQL MI server."
+ },
+ "validateSsisCatalogOnly": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Flag for whether to validate SSIS catalog is reachable on the target SQL MI server."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlMITaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "logins": {
+ "type": {
+ "$ref": "#/299"
+ },
+ "flags": 2,
+ "description": "List of logins on the target server."
+ },
+ "agentJobs": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 2,
+ "description": "List of agent jobs on the target server."
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/301"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/298"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.AzureSqlDbMI"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlMISyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/311"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlMISyncTaskInput",
+ "properties": {
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 1,
+ "description": "Connection information for Azure SQL Database Managed Instance"
+ },
+ "azureApp": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 1,
+ "description": "Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MiSqlConnectionInfo",
+ "properties": {
+ "managedInstanceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Resource id for Azure SQL database Managed instance"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ },
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureActiveDirectoryApp",
+ "properties": {
+ "applicationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Application ID of the Azure Active Directory Application"
+ },
+ "appKey": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Key used to authenticate to the Azure Active Directory Application"
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Tenant id of the customer"
+ },
+ "ignoreAzurePermissions": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Ignore checking azure permissions on the AAD app"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlMISyncTaskOutput",
+ "properties": {
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/308"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.AzureSqlDbMI.Sync.LRS"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/313"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/320"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput",
+ "properties": {
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for PostgreSQL server"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput",
+ "properties": {
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the target server"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/315"
+ },
+ "flags": 2,
+ "description": "List of databases on target server"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/316"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ },
+ "databaseSchemaMap": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0,
+ "description": "Mapping of schemas per database"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem",
+ "properties": {
+ "database": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "schemas": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/317"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/314"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlDbTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "DateTime in UTC when the task was created"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlDbTaskInput",
+ "properties": {
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for target SQL DB"
+ },
+ "queryObjectCounts": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Boolean flag indicating whether to query object counts for each database on the target server"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlDbTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source databases as a map from database name to database id"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version of the target server"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/324"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.SqlDb"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlDbSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ConnectToTargetSqlDbSyncTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for source SQL Server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for target SQL DB"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/324"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConnectToTarget.SqlDb.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetTdeCertificatesSqlTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/339"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetTdeCertificatesSqlTaskInput",
+ "properties": {
+ "connectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for SQL Server"
+ },
+ "backupFileShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 1,
+ "description": "Backup file share information for file share to be used for temporarily storing files."
+ },
+ "selectedCertificates": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 1,
+ "description": "List containing certificate names and corresponding password to use for encrypting the exported certificate."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileShare",
+ "properties": {
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name credential to connect to the share location"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential used to connect to the share location."
+ },
+ "path": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The folder path for this share."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SelectedCertificateInput",
+ "properties": {
+ "certificateName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of certificate to be exported."
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Password to use for encrypting the exported certificate."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/334"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetTdeCertificatesSqlTaskOutput",
+ "properties": {
+ "base64EncodedCertificates": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from certificate name to base 64 encoded format."
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/336"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GetTDECertificates.Sql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/341"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/346"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/347"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesSqlSyncTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for SQL Server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for SQL DB"
+ },
+ "selectedSourceDatabases": {
+ "type": {
+ "$ref": "#/342"
+ },
+ "flags": 1,
+ "description": "List of source database names to collect tables for"
+ },
+ "selectedTargetDatabases": {
+ "type": {
+ "$ref": "#/343"
+ },
+ "flags": 1,
+ "description": "List of target database names to collect tables for"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesSqlSyncTaskOutput",
+ "properties": {
+ "databasesToSourceTables": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from database name to list of source tables"
+ },
+ "databasesToTargetTables": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from database name to list of target tables"
+ },
+ "tableValidationErrors": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from database name to list of validation errors"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/345"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/344"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GetUserTables.AzureSqlDb.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesSqlTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/349"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/353"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Task id"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/354"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesSqlTaskInput",
+ "properties": {
+ "connectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for SQL Server"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/350"
+ },
+ "flags": 1,
+ "description": "List of database names to collect tables for"
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesSqlTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "databasesToTables": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from database name to list of tables"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/352"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/351"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GetUserTables.Sql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesMySqlTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/356"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/360"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesMySqlTaskInput",
+ "properties": {
+ "connectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for SQL Server"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/357"
+ },
+ "flags": 1,
+ "description": "List of database names to collect tables for"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesMySqlTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "databasesToTables": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Mapping from database name to list of tables"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/359"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/358"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GetUserTablesMySql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesOracleTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/363"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/369"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesOracleTaskInput",
+ "properties": {
+ "connectionInfo": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 1,
+ "description": "Information for connecting to Oracle source"
+ },
+ "selectedSchemas": {
+ "type": {
+ "$ref": "#/364"
+ },
+ "flags": 1,
+ "description": "List of Oracle schemas for which to collect tables"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesOracleTaskOutput",
+ "properties": {
+ "schemaName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The schema this result is for"
+ },
+ "tables": {
+ "type": {
+ "$ref": "#/367"
+ },
+ "flags": 2,
+ "description": "List of valid tables found for this schema"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/368"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseTable",
+ "properties": {
+ "hasRows": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Indicates whether table is empty or not"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Schema-qualified name of the table"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/366"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/365"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GetUserTablesOracle"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesPostgreSqlTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/372"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/377"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/378"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesPostgreSqlTaskInput",
+ "properties": {
+ "connectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Information for connecting to PostgreSQL source"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/373"
+ },
+ "flags": 1,
+ "description": "List of PostgreSQL databases for which to collect tables"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "GetUserTablesPostgreSqlTaskOutput",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The database this result is for"
+ },
+ "tables": {
+ "type": {
+ "$ref": "#/375"
+ },
+ "flags": 2,
+ "description": "List of valid tables found for this database"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 2,
+ "description": "Validation errors associated with the task"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/366"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/374"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GetUserTablesPostgreSql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMongoDbTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/380"
+ },
+ "flags": 0,
+ "description": "Describes how a MongoDB data migration should be performed"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/456"
+ },
+ "flags": 2
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbMigrationSettings",
+ "properties": {
+ "boostRUs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets."
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/386"
+ },
+ "flags": 1,
+ "description": "The databases on the source cluster to migrate to the target. The keys are the names of the databases."
+ },
+ "replication": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 0,
+ "description": "Describes how changes will be replicated from the source to the target. The default is OneTime."
+ },
+ "source": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 1,
+ "description": "Settings used to connect to the source cluster"
+ },
+ "target": {
+ "type": {
+ "$ref": "#/136"
+ },
+ "flags": 1,
+ "description": "Settings used to connect to the target cluster"
+ },
+ "throttling": {
+ "type": {
+ "$ref": "#/391"
+ },
+ "flags": 0,
+ "description": "Settings used to limit the resource usage of the migration"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseSettings",
+ "properties": {
+ "collections": {
+ "type": {
+ "$ref": "#/385"
+ },
+ "flags": 1,
+ "description": "The collections on the source database to migrate to the target. The keys are the unqualified names of the collections."
+ },
+ "targetRUs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbCollectionSettings",
+ "properties": {
+ "canDelete": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true."
+ },
+ "shardKey": {
+ "type": {
+ "$ref": "#/383"
+ },
+ "flags": 0,
+ "description": "Describes a MongoDB shard key"
+ },
+ "targetRUs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbShardKeySetting",
+ "properties": {
+ "fields": {
+ "type": {
+ "$ref": "#/384"
+ },
+ "flags": 1,
+ "description": "The fields within the shard key"
+ },
+ "isUnique": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether the shard key is unique"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/147"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseSettingsCollections",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/382"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbMigrationSettingsDatabases",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/381"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OneTime"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Continuous"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/387"
+ },
+ {
+ "$ref": "#/388"
+ },
+ {
+ "$ref": "#/389"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbThrottlingSettings",
+ "properties": {
+ "minFreeCpu": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The percentage of CPU time that the migrator will try to avoid using, from 0 to 100"
+ },
+ "minFreeMemoryMb": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The number of megabytes of RAM that the migrator will try to avoid using"
+ },
+ "maxParallelism": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The maximum number of work items (e.g. collection copies) that will be processed in parallel"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MongoDbProgress",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "bytesCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of document bytes copied during the Copying stage"
+ },
+ "documentsCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of documents copied during the Copying stage"
+ },
+ "elapsedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)"
+ },
+ "errors": {
+ "type": {
+ "$ref": "#/398"
+ },
+ "flags": 1,
+ "description": "The errors and warnings that have occurred for the current object. The keys are the error codes."
+ },
+ "eventsPending": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events awaiting replay"
+ },
+ "eventsReplayed": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events replayed so far"
+ },
+ "lastEventTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event received, or null if no oplog event has been received yet"
+ },
+ "lastReplayTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "qualifiedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/410"
+ },
+ "flags": 1
+ },
+ "totalBytes": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown"
+ },
+ "totalDocuments": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown"
+ }
+ },
+ "elements": {
+ "Collection": {
+ "$ref": "#/411"
+ },
+ "Database": {
+ "$ref": "#/413"
+ },
+ "Migration": {
+ "$ref": "#/434"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbError",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The non-localized, machine-readable code that describes the error or warning"
+ },
+ "count": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "The number of times the error or warning has occurred"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The localized, human-readable message that describes the error or warning"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/397"
+ },
+ "flags": 0,
+ "description": "The type of error or warning"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidationError"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/394"
+ },
+ {
+ "$ref": "#/395"
+ },
+ {
+ "$ref": "#/396"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbProgressErrors",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/393"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidatingInput"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restarting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InitialReplay"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replaying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Finalizing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Complete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/399"
+ },
+ {
+ "$ref": "#/400"
+ },
+ {
+ "$ref": "#/401"
+ },
+ {
+ "$ref": "#/402"
+ },
+ {
+ "$ref": "#/403"
+ },
+ {
+ "$ref": "#/404"
+ },
+ {
+ "$ref": "#/405"
+ },
+ {
+ "$ref": "#/406"
+ },
+ {
+ "$ref": "#/407"
+ },
+ {
+ "$ref": "#/408"
+ },
+ {
+ "$ref": "#/409"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbCollectionProgress",
+ "properties": {
+ "resultType": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 1,
+ "description": "The type of progress object"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Collection"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseProgress",
+ "properties": {
+ "collections": {
+ "type": {
+ "$ref": "#/432"
+ },
+ "flags": 0,
+ "description": "The progress of the collections in the database. The keys are the unqualified names of the collections"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/433"
+ },
+ "flags": 1,
+ "description": "The type of progress object"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbCollectionProgress",
+ "properties": {
+ "bytesCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of document bytes copied during the Copying stage"
+ },
+ "documentsCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of documents copied during the Copying stage"
+ },
+ "elapsedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)"
+ },
+ "errors": {
+ "type": {
+ "$ref": "#/415"
+ },
+ "flags": 1,
+ "description": "The errors and warnings that have occurred for the current object. The keys are the error codes."
+ },
+ "eventsPending": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events awaiting replay"
+ },
+ "eventsReplayed": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events replayed so far"
+ },
+ "lastEventTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event received, or null if no oplog event has been received yet"
+ },
+ "lastReplayTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "qualifiedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 1,
+ "description": "The type of progress object"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/431"
+ },
+ "flags": 1
+ },
+ "totalBytes": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown"
+ },
+ "totalDocuments": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbProgressErrors",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/393"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Database"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Collection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/416"
+ },
+ {
+ "$ref": "#/417"
+ },
+ {
+ "$ref": "#/418"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidatingInput"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restarting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InitialReplay"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replaying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Finalizing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Complete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/420"
+ },
+ {
+ "$ref": "#/421"
+ },
+ {
+ "$ref": "#/422"
+ },
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/424"
+ },
+ {
+ "$ref": "#/425"
+ },
+ {
+ "$ref": "#/426"
+ },
+ {
+ "$ref": "#/427"
+ },
+ {
+ "$ref": "#/428"
+ },
+ {
+ "$ref": "#/429"
+ },
+ {
+ "$ref": "#/430"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseProgressCollections",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/414"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Database"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbMigrationProgress",
+ "properties": {
+ "databases": {
+ "type": {
+ "$ref": "#/454"
+ },
+ "flags": 0,
+ "description": "The progress of the databases in the migration. The keys are the names of the databases"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/455"
+ },
+ "flags": 1,
+ "description": "The type of progress object"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseProgress",
+ "properties": {
+ "collections": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 0,
+ "description": "The progress of the collections in the database. The keys are the unqualified names of the collections"
+ },
+ "bytesCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of document bytes copied during the Copying stage"
+ },
+ "documentsCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of documents copied during the Copying stage"
+ },
+ "elapsedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)"
+ },
+ "errors": {
+ "type": {
+ "$ref": "#/437"
+ },
+ "flags": 1,
+ "description": "The errors and warnings that have occurred for the current object. The keys are the error codes."
+ },
+ "eventsPending": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events awaiting replay"
+ },
+ "eventsReplayed": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events replayed so far"
+ },
+ "lastEventTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event received, or null if no oplog event has been received yet"
+ },
+ "lastReplayTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "qualifiedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/441"
+ },
+ "flags": 1,
+ "description": "The type of progress object"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/453"
+ },
+ "flags": 1
+ },
+ "totalBytes": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown"
+ },
+ "totalDocuments": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbDatabaseProgressCollections",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/414"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbProgressErrors",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/393"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Database"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Collection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/438"
+ },
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/440"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidatingInput"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restarting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InitialReplay"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replaying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Finalizing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Complete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/442"
+ },
+ {
+ "$ref": "#/443"
+ },
+ {
+ "$ref": "#/444"
+ },
+ {
+ "$ref": "#/445"
+ },
+ {
+ "$ref": "#/446"
+ },
+ {
+ "$ref": "#/447"
+ },
+ {
+ "$ref": "#/448"
+ },
+ {
+ "$ref": "#/449"
+ },
+ {
+ "$ref": "#/450"
+ },
+ {
+ "$ref": "#/451"
+ },
+ {
+ "$ref": "#/452"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbMigrationProgressDatabases",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/435"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migration"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/392"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.MongoDb"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/510"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "isCloneable": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "whether the task can be cloned or not"
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Task id"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/511"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for source MySQL"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for MySQL"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/462"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "makeSourceServerReadOnly": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Setting to set the source server read only"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Parameter to specify when the migration started"
+ },
+ "optionalAgentSettings": {
+ "type": {
+ "$ref": "#/463"
+ },
+ "flags": 0,
+ "description": "Optional parameters for fine tuning the data transfer rate during migration"
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineDatabaseInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of target database. Note: Target database will be truncated before starting migration."
+ },
+ "tableMap": {
+ "type": {
+ "$ref": "#/461"
+ },
+ "flags": 0,
+ "description": "Mapping of source to target tables"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/460"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelOutput": {
+ "$ref": "#/465"
+ },
+ "ErrorOutput": {
+ "$ref": "#/483"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/485"
+ },
+ "TableLevelOutput": {
+ "$ref": "#/500"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/473"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/480"
+ },
+ "flags": 2,
+ "description": "Migration stage that this database is in"
+ },
+ "statusMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Status message"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "numberOfObjects": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of objects"
+ },
+ "numberOfObjectsCompleted": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of successfully completed objects"
+ },
+ "errorCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of database/object errors."
+ },
+ "errorPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all errors of the item"
+ },
+ "resultPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all sub-tem results of the item"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/481"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings."
+ },
+ "lastStorageUpdate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last time the storage was updated"
+ },
+ "objectSummary": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Summary of object results in the migration"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/482"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/466"
+ },
+ {
+ "$ref": "#/467"
+ },
+ {
+ "$ref": "#/468"
+ },
+ {
+ "$ref": "#/469"
+ },
+ {
+ "$ref": "#/470"
+ },
+ {
+ "$ref": "#/471"
+ },
+ {
+ "$ref": "#/472"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialize"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Backup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FileCopy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/474"
+ },
+ {
+ "$ref": "#/475"
+ },
+ {
+ "$ref": "#/476"
+ },
+ {
+ "$ref": "#/477"
+ },
+ {
+ "$ref": "#/478"
+ },
+ {
+ "$ref": "#/479"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/484"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "durationInSeconds": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Duration of task execution in seconds."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/496"
+ },
+ "flags": 2,
+ "description": "Current status of migration"
+ },
+ "statusMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration status message"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Selected databases as a map from database name to database id"
+ },
+ "databaseSummary": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Summary of database results in the migration"
+ },
+ "migrationReportResult": {
+ "type": {
+ "$ref": "#/497"
+ },
+ "flags": 0,
+ "description": "Migration Report Result, provides unique url for downloading your migration report."
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/498"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings."
+ },
+ "lastStorageUpdate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last time the storage was updated"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/499"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Connecting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SourceAndTargetSelected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SelectLogins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Configured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/486"
+ },
+ {
+ "$ref": "#/487"
+ },
+ {
+ "$ref": "#/488"
+ },
+ {
+ "$ref": "#/489"
+ },
+ {
+ "$ref": "#/490"
+ },
+ {
+ "$ref": "#/491"
+ },
+ {
+ "$ref": "#/492"
+ },
+ {
+ "$ref": "#/493"
+ },
+ {
+ "$ref": "#/494"
+ },
+ {
+ "$ref": "#/495"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationReportResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Migration validation result identifier"
+ },
+ "reportUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The url of the report."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel",
+ "properties": {
+ "objectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the item"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/508"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "statusMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Status message"
+ },
+ "itemsCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of items"
+ },
+ "itemsCompletedCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of successfully completed items"
+ },
+ "errorPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all errors of the item"
+ },
+ "resultPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all sub-tem results of the item"
+ },
+ "lastStorageUpdate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last time the storage was updated"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/509"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/501"
+ },
+ {
+ "$ref": "#/502"
+ },
+ {
+ "$ref": "#/503"
+ },
+ {
+ "$ref": "#/504"
+ },
+ {
+ "$ref": "#/505"
+ },
+ {
+ "$ref": "#/506"
+ },
+ {
+ "$ref": "#/507"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TableLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/464"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.MySql.AzureDbForMySql"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/513"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/559"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/560"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for source MySQL"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for MySQL"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/519"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncDatabaseInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of target database. Note: Target database will be truncated before starting migration."
+ },
+ "migrationSetting": {
+ "type": {
+ "$ref": "#/515"
+ },
+ "flags": 0,
+ "description": "Migration settings which tune the migration behavior"
+ },
+ "sourceSetting": {
+ "type": {
+ "$ref": "#/516"
+ },
+ "flags": 0,
+ "description": "Source settings to tune source endpoint migration behavior"
+ },
+ "targetSetting": {
+ "type": {
+ "$ref": "#/517"
+ },
+ "flags": 0,
+ "description": "Target settings to tune target endpoint migration behavior"
+ },
+ "tableMap": {
+ "type": {
+ "$ref": "#/518"
+ },
+ "flags": 0,
+ "description": "Mapping of source to target tables"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/514"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelErrorOutput": {
+ "$ref": "#/521"
+ },
+ "DatabaseLevelOutput": {
+ "$ref": "#/525"
+ },
+ "ErrorOutput": {
+ "$ref": "#/546"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/548"
+ },
+ "TableLevelOutput": {
+ "$ref": "#/550"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError",
+ "properties": {
+ "errorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error message"
+ },
+ "events": {
+ "type": {
+ "$ref": "#/523"
+ },
+ "flags": 0,
+ "description": "List of error events."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/524"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SyncMigrationDatabaseErrorEvent",
+ "properties": {
+ "timestampString": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "String value of timestamp."
+ },
+ "eventTypeString": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Event type."
+ },
+ "eventText": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Event text."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/522"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "migrationState": {
+ "type": {
+ "$ref": "#/544"
+ },
+ "flags": 2,
+ "description": "Migration state that this database is in"
+ },
+ "incomingChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of incoming changes"
+ },
+ "appliedChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied changes"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc inserts"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc deletes"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc updates"
+ },
+ "fullLoadCompletedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables completed in full load"
+ },
+ "fullLoadLoadingTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables loading in full load"
+ },
+ "fullLoadQueuedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables queued in full load"
+ },
+ "fullLoadErroredTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables errored in full load"
+ },
+ "initializationCompleted": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Indicates if initial load (full load) has been completed"
+ },
+ "latency": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "CDC apply latency"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/545"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UNDEFINED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CONFIGURING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "INITIALIAZING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "STARTING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RUNNING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "READY_TO_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_COMPLETED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/526"
+ },
+ {
+ "$ref": "#/527"
+ },
+ {
+ "$ref": "#/528"
+ },
+ {
+ "$ref": "#/529"
+ },
+ {
+ "$ref": "#/530"
+ },
+ {
+ "$ref": "#/531"
+ },
+ {
+ "$ref": "#/532"
+ },
+ {
+ "$ref": "#/533"
+ },
+ {
+ "$ref": "#/534"
+ },
+ {
+ "$ref": "#/535"
+ },
+ {
+ "$ref": "#/536"
+ },
+ {
+ "$ref": "#/537"
+ },
+ {
+ "$ref": "#/538"
+ },
+ {
+ "$ref": "#/539"
+ },
+ {
+ "$ref": "#/540"
+ },
+ {
+ "$ref": "#/541"
+ },
+ {
+ "$ref": "#/542"
+ },
+ {
+ "$ref": "#/543"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/547"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server name"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server name"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/549"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel",
+ "properties": {
+ "tableName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the table"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Number of applied inserts"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Number of applied updates"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Number of applied deletes"
+ },
+ "fullLoadEstFinishTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Estimate to finish full load"
+ },
+ "fullLoadStartedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load start time"
+ },
+ "fullLoadEndedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load end time"
+ },
+ "fullLoadTotalRows": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of rows applied in full load"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/557"
+ },
+ "flags": 2,
+ "description": "Current state of the table migration"
+ },
+ "totalChangesApplied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Total number of applied changes"
+ },
+ "dataErrorsCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of data errors occurred"
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last modified time on target"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/558"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BEFORE_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FULL_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ERROR"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/551"
+ },
+ {
+ "$ref": "#/552"
+ },
+ {
+ "$ref": "#/553"
+ },
+ {
+ "$ref": "#/554"
+ },
+ {
+ "$ref": "#/555"
+ },
+ {
+ "$ref": "#/556"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TableLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/520"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.MySql.AzureDbForMySql.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbForPostgreSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/562"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/607"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/608"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/568"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for PostgreSQL"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 1,
+ "description": "Connection information for source Oracle"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncDatabaseInput",
+ "properties": {
+ "caseManipulation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "How to handle object name casing: either Preserve or ToLower"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the migration pipeline"
+ },
+ "schemaName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the source schema"
+ },
+ "tableMap": {
+ "type": {
+ "$ref": "#/564"
+ },
+ "flags": 0,
+ "description": "Mapping of source to target tables"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of target database. Note: Target database will be truncated before starting migration."
+ },
+ "migrationSetting": {
+ "type": {
+ "$ref": "#/565"
+ },
+ "flags": 0,
+ "description": "Migration settings which tune the migration behavior"
+ },
+ "sourceSetting": {
+ "type": {
+ "$ref": "#/566"
+ },
+ "flags": 0,
+ "description": "Source settings to tune source endpoint migration behavior"
+ },
+ "targetSetting": {
+ "type": {
+ "$ref": "#/567"
+ },
+ "flags": 0,
+ "description": "Target settings to tune target endpoint migration behavior"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/563"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelErrorOutput": {
+ "$ref": "#/570"
+ },
+ "DatabaseLevelOutput": {
+ "$ref": "#/573"
+ },
+ "ErrorOutput": {
+ "$ref": "#/594"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/596"
+ },
+ "TableLevelOutput": {
+ "$ref": "#/598"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError",
+ "properties": {
+ "errorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error message"
+ },
+ "events": {
+ "type": {
+ "$ref": "#/571"
+ },
+ "flags": 0,
+ "description": "List of error events."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/572"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/522"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "migrationState": {
+ "type": {
+ "$ref": "#/592"
+ },
+ "flags": 2,
+ "description": "Migration state that this database is in"
+ },
+ "incomingChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of incoming changes"
+ },
+ "appliedChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied changes"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc inserts"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc deletes"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc updates"
+ },
+ "fullLoadCompletedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables completed in full load"
+ },
+ "fullLoadLoadingTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables loading in full load"
+ },
+ "fullLoadQueuedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables queued in full load"
+ },
+ "fullLoadErroredTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables errored in full load"
+ },
+ "initializationCompleted": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Indicates if initial load (full load) has been completed"
+ },
+ "latency": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "CDC apply latency"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/593"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UNDEFINED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CONFIGURING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "INITIALIAZING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "STARTING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RUNNING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "READY_TO_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_COMPLETED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/574"
+ },
+ {
+ "$ref": "#/575"
+ },
+ {
+ "$ref": "#/576"
+ },
+ {
+ "$ref": "#/577"
+ },
+ {
+ "$ref": "#/578"
+ },
+ {
+ "$ref": "#/579"
+ },
+ {
+ "$ref": "#/580"
+ },
+ {
+ "$ref": "#/581"
+ },
+ {
+ "$ref": "#/582"
+ },
+ {
+ "$ref": "#/583"
+ },
+ {
+ "$ref": "#/584"
+ },
+ {
+ "$ref": "#/585"
+ },
+ {
+ "$ref": "#/586"
+ },
+ {
+ "$ref": "#/587"
+ },
+ {
+ "$ref": "#/588"
+ },
+ {
+ "$ref": "#/589"
+ },
+ {
+ "$ref": "#/590"
+ },
+ {
+ "$ref": "#/591"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/595"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server name"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server name"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/597"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel",
+ "properties": {
+ "tableName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the table"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied inserts"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied updates"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied deletes"
+ },
+ "fullLoadEstFinishTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Estimate to finish full load"
+ },
+ "fullLoadStartedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load start time"
+ },
+ "fullLoadEndedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load end time"
+ },
+ "fullLoadTotalRows": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of rows applied in full load"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/605"
+ },
+ "flags": 2,
+ "description": "Current state of the table migration"
+ },
+ "totalChangesApplied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Total number of applied changes"
+ },
+ "dataErrorsCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of data errors occurred"
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last modified time on target"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/606"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BEFORE_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FULL_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ERROR"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/599"
+ },
+ {
+ "$ref": "#/600"
+ },
+ {
+ "$ref": "#/601"
+ },
+ {
+ "$ref": "#/602"
+ },
+ {
+ "$ref": "#/603"
+ },
+ {
+ "$ref": "#/604"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TableLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/569"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.Oracle.AzureDbForPostgreSql.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/610"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/685"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "task id"
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "DateTime in UTC when the task was created"
+ },
+ "isCloneable": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "whether the task can be cloned or not"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/686"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/618"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for target Azure Database for PostgreSQL"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 1,
+ "description": "Connection information for source PostgreSQL"
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of target database. Note: Target database will be truncated before starting migration."
+ },
+ "migrationSetting": {
+ "type": {
+ "$ref": "#/613"
+ },
+ "flags": 0,
+ "description": "Migration settings which tune the migration behavior"
+ },
+ "sourceSetting": {
+ "type": {
+ "$ref": "#/614"
+ },
+ "flags": 0,
+ "description": "Source settings to tune source endpoint migration behavior"
+ },
+ "targetSetting": {
+ "type": {
+ "$ref": "#/615"
+ },
+ "flags": 0,
+ "description": "Target settings to tune target endpoint migration behavior"
+ },
+ "selectedTables": {
+ "type": {
+ "$ref": "#/617"
+ },
+ "flags": 0,
+ "description": "Tables selected for migration"
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/612"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the table to migrate"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/616"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/611"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelErrorOutput": {
+ "$ref": "#/620"
+ },
+ "DatabaseLevelOutput": {
+ "$ref": "#/623"
+ },
+ "ErrorOutput": {
+ "$ref": "#/644"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/647"
+ },
+ "TableLevelOutput": {
+ "$ref": "#/676"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError",
+ "properties": {
+ "errorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error message"
+ },
+ "events": {
+ "type": {
+ "$ref": "#/621"
+ },
+ "flags": 0,
+ "description": "List of error events."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/622"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/522"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "migrationState": {
+ "type": {
+ "$ref": "#/642"
+ },
+ "flags": 2,
+ "description": "Migration state that this database is in"
+ },
+ "incomingChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of incoming changes"
+ },
+ "appliedChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied changes"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc inserts"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc deletes"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc updates"
+ },
+ "fullLoadCompletedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables completed in full load"
+ },
+ "fullLoadLoadingTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables loading in full load"
+ },
+ "fullLoadQueuedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables queued in full load"
+ },
+ "fullLoadErroredTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables errored in full load"
+ },
+ "initializationCompleted": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Indicates if initial load (full load) has been completed"
+ },
+ "latency": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "CDC apply latency"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/643"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UNDEFINED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CONFIGURING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "INITIALIAZING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "STARTING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RUNNING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "READY_TO_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_COMPLETED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/624"
+ },
+ {
+ "$ref": "#/625"
+ },
+ {
+ "$ref": "#/626"
+ },
+ {
+ "$ref": "#/627"
+ },
+ {
+ "$ref": "#/628"
+ },
+ {
+ "$ref": "#/629"
+ },
+ {
+ "$ref": "#/630"
+ },
+ {
+ "$ref": "#/631"
+ },
+ {
+ "$ref": "#/632"
+ },
+ {
+ "$ref": "#/633"
+ },
+ {
+ "$ref": "#/634"
+ },
+ {
+ "$ref": "#/635"
+ },
+ {
+ "$ref": "#/636"
+ },
+ {
+ "$ref": "#/637"
+ },
+ {
+ "$ref": "#/638"
+ },
+ {
+ "$ref": "#/639"
+ },
+ {
+ "$ref": "#/640"
+ },
+ {
+ "$ref": "#/641"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "events": {
+ "type": {
+ "$ref": "#/645"
+ },
+ "flags": 0,
+ "description": "List of error events"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/646"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/522"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server name"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server name"
+ },
+ "sourceServerType": {
+ "type": {
+ "$ref": "#/659"
+ },
+ "flags": 2,
+ "description": "Source server type."
+ },
+ "targetServerType": {
+ "type": {
+ "$ref": "#/667"
+ },
+ "flags": 2,
+ "description": "Target server type."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/674"
+ },
+ "flags": 2,
+ "description": "Migration status"
+ },
+ "databaseCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Number of databases to include"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/675"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Access"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DB2"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MySQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Oracle"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sybase"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PostgreSQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLRDS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MySQLRDS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PostgreSQLRDS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/648"
+ },
+ {
+ "$ref": "#/649"
+ },
+ {
+ "$ref": "#/650"
+ },
+ {
+ "$ref": "#/651"
+ },
+ {
+ "$ref": "#/652"
+ },
+ {
+ "$ref": "#/653"
+ },
+ {
+ "$ref": "#/654"
+ },
+ {
+ "$ref": "#/655"
+ },
+ {
+ "$ref": "#/656"
+ },
+ {
+ "$ref": "#/657"
+ },
+ {
+ "$ref": "#/658"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLServer"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLDW"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLMI"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureDBForMySql"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureDBForPostgresSQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDB"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/660"
+ },
+ {
+ "$ref": "#/661"
+ },
+ {
+ "$ref": "#/662"
+ },
+ {
+ "$ref": "#/663"
+ },
+ {
+ "$ref": "#/664"
+ },
+ {
+ "$ref": "#/665"
+ },
+ {
+ "$ref": "#/666"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UNDEFINED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PENDING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ACTION_REQUIRED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/668"
+ },
+ {
+ "$ref": "#/669"
+ },
+ {
+ "$ref": "#/670"
+ },
+ {
+ "$ref": "#/671"
+ },
+ {
+ "$ref": "#/672"
+ },
+ {
+ "$ref": "#/673"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel",
+ "properties": {
+ "tableName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the table"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied inserts"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied updates"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied deletes"
+ },
+ "fullLoadEstFinishTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Estimate to finish full load"
+ },
+ "fullLoadStartedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load start time"
+ },
+ "fullLoadEndedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load end time"
+ },
+ "fullLoadTotalRows": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of rows applied in full load"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/683"
+ },
+ "flags": 2,
+ "description": "Current state of the table migration"
+ },
+ "totalChangesApplied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Total number of applied changes"
+ },
+ "dataErrorsCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of data errors occurred"
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last modified time on target"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/684"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BEFORE_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FULL_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ERROR"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/677"
+ },
+ {
+ "$ref": "#/678"
+ },
+ {
+ "$ref": "#/679"
+ },
+ {
+ "$ref": "#/680"
+ },
+ {
+ "$ref": "#/681"
+ },
+ {
+ "$ref": "#/682"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TableLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/619"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/688"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/734"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/735"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/694"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "validationOptions": {
+ "type": {
+ "$ref": "#/695"
+ },
+ "flags": 0,
+ "description": "Validation options"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncDatabaseInput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Unique identifier for database"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Target database name"
+ },
+ "schemaName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Schema name to be migrated"
+ },
+ "tableMap": {
+ "type": {
+ "$ref": "#/690"
+ },
+ "flags": 0,
+ "description": "Mapping of source to target tables"
+ },
+ "migrationSetting": {
+ "type": {
+ "$ref": "#/691"
+ },
+ "flags": 0,
+ "description": "Migration settings which tune the migration behavior"
+ },
+ "sourceSetting": {
+ "type": {
+ "$ref": "#/692"
+ },
+ "flags": 0,
+ "description": "Source settings to tune source endpoint migration behavior"
+ },
+ "targetSetting": {
+ "type": {
+ "$ref": "#/693"
+ },
+ "flags": 0,
+ "description": "Target settings to tune target endpoint migration behavior"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncDatabaseInputTableMap",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/689"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationValidationOptions",
+ "properties": {
+ "enableSchemaValidation": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Allows to compare the schema information between source and target."
+ },
+ "enableDataIntegrityValidation": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Allows to perform a checksum based data integrity validation between source and target for the selected database / tables ."
+ },
+ "enableQueryAnalysisValidation": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Allows to perform a quick and intelligent query analysis by retrieving queries from the source database and executes them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelErrorOutput": {
+ "$ref": "#/697"
+ },
+ "DatabaseLevelOutput": {
+ "$ref": "#/700"
+ },
+ "ErrorOutput": {
+ "$ref": "#/721"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/723"
+ },
+ "TableLevelOutput": {
+ "$ref": "#/725"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskOutputDatabaseError",
+ "properties": {
+ "errorMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error message"
+ },
+ "events": {
+ "type": {
+ "$ref": "#/698"
+ },
+ "flags": 0,
+ "description": "List of error events."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/699"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/522"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "migrationState": {
+ "type": {
+ "$ref": "#/719"
+ },
+ "flags": 2,
+ "description": "Migration state that this database is in"
+ },
+ "incomingChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of incoming changes"
+ },
+ "appliedChanges": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied changes"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc inserts"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc deletes"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of cdc updates"
+ },
+ "fullLoadCompletedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables completed in full load"
+ },
+ "fullLoadLoadingTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables loading in full load"
+ },
+ "fullLoadQueuedTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables queued in full load"
+ },
+ "fullLoadErroredTables": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of tables errored in full load"
+ },
+ "initializationCompleted": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Indicates if initial load (full load) has been completed"
+ },
+ "latency": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "CDC apply latency"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/720"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UNDEFINED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CONFIGURING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "INITIALIAZING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "STARTING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RUNNING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "READY_TO_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATING"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VALIDATION_FAILED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RESTORE_COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BACKUP_COMPLETED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/701"
+ },
+ {
+ "$ref": "#/702"
+ },
+ {
+ "$ref": "#/703"
+ },
+ {
+ "$ref": "#/704"
+ },
+ {
+ "$ref": "#/705"
+ },
+ {
+ "$ref": "#/706"
+ },
+ {
+ "$ref": "#/707"
+ },
+ {
+ "$ref": "#/708"
+ },
+ {
+ "$ref": "#/709"
+ },
+ {
+ "$ref": "#/710"
+ },
+ {
+ "$ref": "#/711"
+ },
+ {
+ "$ref": "#/712"
+ },
+ {
+ "$ref": "#/713"
+ },
+ {
+ "$ref": "#/714"
+ },
+ {
+ "$ref": "#/715"
+ },
+ {
+ "$ref": "#/716"
+ },
+ {
+ "$ref": "#/717"
+ },
+ {
+ "$ref": "#/718"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/722"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server name"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server name"
+ },
+ "databaseCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Count of databases"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/724"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbSyncTaskOutputTableLevel",
+ "properties": {
+ "tableName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the table"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "cdcInsertCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied inserts"
+ },
+ "cdcUpdateCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied updates"
+ },
+ "cdcDeleteCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of applied deletes"
+ },
+ "fullLoadEstFinishTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Estimate to finish full load"
+ },
+ "fullLoadStartedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load start time"
+ },
+ "fullLoadEndedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Full load end time"
+ },
+ "fullLoadTotalRows": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of rows applied in full load"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/732"
+ },
+ "flags": 2,
+ "description": "Current state of the table migration"
+ },
+ "totalChangesApplied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Total number of applied changes"
+ },
+ "dataErrorsCounter": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of data errors occurred"
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Last modified time on target"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/733"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BEFORE_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FULL_LOAD"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ERROR"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/726"
+ },
+ {
+ "$ref": "#/727"
+ },
+ {
+ "$ref": "#/728"
+ },
+ {
+ "$ref": "#/729"
+ },
+ {
+ "$ref": "#/730"
+ },
+ {
+ "$ref": "#/731"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TableLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/696"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.SqlServer.AzureSqlDb.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/737"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/824"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "task id"
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "DateTime in UTC when the task was created"
+ },
+ "parentTaskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "parent task id"
+ },
+ "isCloneable": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "whether the task can be cloned or not"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/825"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/740"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date and time relative to UTC when the migration was started on"
+ },
+ "selectedLogins": {
+ "type": {
+ "$ref": "#/741"
+ },
+ "flags": 0,
+ "description": "Logins to migrate."
+ },
+ "selectedAgentJobs": {
+ "type": {
+ "$ref": "#/742"
+ },
+ "flags": 0,
+ "description": "Agent Jobs to migrate."
+ },
+ "backupFileShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Backup file share information for all selected databases."
+ },
+ "backupBlobShare": {
+ "type": {
+ "$ref": "#/743"
+ },
+ "flags": 1,
+ "description": "SAS URI of Azure Storage Account Container to be used for storing backup files."
+ },
+ "backupMode": {
+ "type": {
+ "$ref": "#/746"
+ },
+ "flags": 0,
+ "description": "Backup Mode to specify whether to use existing backup or create new backup. If using existing backups, backup file paths are required to be provided in selectedDatabases."
+ },
+ "aadDomainName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected"
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMIDatabaseInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the database"
+ },
+ "restoreDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the database at destination"
+ },
+ "backupFileShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Backup file share information for backing up this database."
+ },
+ "backupFilePaths": {
+ "type": {
+ "$ref": "#/739"
+ },
+ "flags": 0,
+ "description": "The list of backup files to be used in case of existing backups."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "id of the database"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/738"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BlobShare",
+ "properties": {
+ "sasUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "SAS URI of Azure Storage Account Container."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateBackup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ExistingBackup"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/744"
+ },
+ {
+ "$ref": "#/745"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateSqlServerSqlMITaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "AgentJobLevelOutput": {
+ "$ref": "#/748"
+ },
+ "DatabaseLevelOutput": {
+ "$ref": "#/759"
+ },
+ "ErrorOutput": {
+ "$ref": "#/777"
+ },
+ "LoginLevelOutput": {
+ "$ref": "#/779"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/800"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskOutputAgentJobLevel",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Agent Job name."
+ },
+ "isEnabled": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "The state of the original Agent Job."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/756"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/757"
+ },
+ "flags": 2,
+ "description": "Migration errors and warnings per job"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/758"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/749"
+ },
+ {
+ "$ref": "#/750"
+ },
+ {
+ "$ref": "#/751"
+ },
+ {
+ "$ref": "#/752"
+ },
+ {
+ "$ref": "#/753"
+ },
+ {
+ "$ref": "#/754"
+ },
+ {
+ "$ref": "#/755"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AgentJobLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "sizeMB": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Size of the database in megabytes"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/767"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/774"
+ },
+ "flags": 2,
+ "description": "Current stage of migration"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/775"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/776"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/760"
+ },
+ {
+ "$ref": "#/761"
+ },
+ {
+ "$ref": "#/762"
+ },
+ {
+ "$ref": "#/763"
+ },
+ {
+ "$ref": "#/764"
+ },
+ {
+ "$ref": "#/765"
+ },
+ {
+ "$ref": "#/766"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialize"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Backup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FileCopy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/768"
+ },
+ {
+ "$ref": "#/769"
+ },
+ {
+ "$ref": "#/770"
+ },
+ {
+ "$ref": "#/771"
+ },
+ {
+ "$ref": "#/772"
+ },
+ {
+ "$ref": "#/773"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/778"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskOutputLoginLevel",
+ "properties": {
+ "loginName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Login name."
+ },
+ "state": {
+ "type": {
+ "$ref": "#/787"
+ },
+ "flags": 2,
+ "description": "Current state of login"
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/797"
+ },
+ "flags": 2,
+ "description": "Current stage of login"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Login migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Login migration end time"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Login migration progress message"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/798"
+ },
+ "flags": 2,
+ "description": "Login migration errors and warnings per login"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/799"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/780"
+ },
+ {
+ "$ref": "#/781"
+ },
+ {
+ "$ref": "#/782"
+ },
+ {
+ "$ref": "#/783"
+ },
+ {
+ "$ref": "#/784"
+ },
+ {
+ "$ref": "#/785"
+ },
+ {
+ "$ref": "#/786"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialize"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LoginMigration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EstablishUserMapping"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AssignRoleMembership"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AssignRoleOwnership"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EstablishServerPermissions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EstablishObjectPermissions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/788"
+ },
+ {
+ "$ref": "#/789"
+ },
+ {
+ "$ref": "#/790"
+ },
+ {
+ "$ref": "#/791"
+ },
+ {
+ "$ref": "#/792"
+ },
+ {
+ "$ref": "#/793"
+ },
+ {
+ "$ref": "#/794"
+ },
+ {
+ "$ref": "#/795"
+ },
+ {
+ "$ref": "#/796"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LoginLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMITaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/811"
+ },
+ "flags": 2,
+ "description": "Current status of migration"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/819"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "agentJobs": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Selected agent jobs as a map from name to id"
+ },
+ "logins": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Selected logins as a map from name to id"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "serverRoleResults": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Map of server role migration results."
+ },
+ "orphanedUsersInfo": {
+ "type": {
+ "$ref": "#/821"
+ },
+ "flags": 2,
+ "description": "List of orphaned users."
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Selected databases as a map from database name to database id"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/822"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/823"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Connecting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SourceAndTargetSelected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SelectLogins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Configured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/801"
+ },
+ {
+ "$ref": "#/802"
+ },
+ {
+ "$ref": "#/803"
+ },
+ {
+ "$ref": "#/804"
+ },
+ {
+ "$ref": "#/805"
+ },
+ {
+ "$ref": "#/806"
+ },
+ {
+ "$ref": "#/807"
+ },
+ {
+ "$ref": "#/808"
+ },
+ {
+ "$ref": "#/809"
+ },
+ {
+ "$ref": "#/810"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/812"
+ },
+ {
+ "$ref": "#/813"
+ },
+ {
+ "$ref": "#/814"
+ },
+ {
+ "$ref": "#/815"
+ },
+ {
+ "$ref": "#/816"
+ },
+ {
+ "$ref": "#/817"
+ },
+ {
+ "$ref": "#/818"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OrphanedUserInfo",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the orphaned user"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Parent database of the user"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/820"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/747"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.SqlServer.AzureSqlDbMI"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMISyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/827"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/876"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "DateTime in UTC when the task was created"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/877"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMISyncTaskInput",
+ "properties": {
+ "numberOfParallelDatabaseMigrations": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Number of database migrations to start in parallel"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/828"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "backupFileShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Backup file share information for all selected databases."
+ },
+ "storageResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Fully qualified resourceId of storage"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for source SQL Server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 1,
+ "description": "Connection information for Azure SQL Database Managed Instance"
+ },
+ "azureApp": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 1,
+ "description": "Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/738"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateSqlServerSqlMISyncTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelOutput": {
+ "$ref": "#/830"
+ },
+ "ErrorOutput": {
+ "$ref": "#/864"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/866"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel",
+ "properties": {
+ "sourceDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the database"
+ },
+ "migrationState": {
+ "type": {
+ "$ref": "#/841"
+ },
+ "flags": 2,
+ "description": "Current state of database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database migration end time"
+ },
+ "fullBackupSetInfo": {
+ "type": {
+ "$ref": "#/842"
+ },
+ "flags": 2,
+ "description": "Details of full backup set"
+ },
+ "lastRestoredBackupSetInfo": {
+ "type": {
+ "$ref": "#/842"
+ },
+ "flags": 2,
+ "description": "Last applied backup set information"
+ },
+ "activeBackupSets": {
+ "type": {
+ "$ref": "#/861"
+ },
+ "flags": 2,
+ "description": "Backup sets that are currently active (Either being uploaded or getting restored)"
+ },
+ "containerName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of container created in the Azure Storage account where backups are copied to"
+ },
+ "errorPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "prefix string to use for querying errors for this database"
+ },
+ "isFullBackupRestored": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Whether full backup has been applied to the target database or not"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/862"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/863"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UNDEFINED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "INITIAL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FULL_BACKUP_UPLOAD_START"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LOG_SHIPPING_START"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UPLOAD_LOG_FILES_START"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CUTOVER_START"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "POST_CUTOVER_COMPLETE"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CANCELLED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/831"
+ },
+ {
+ "$ref": "#/832"
+ },
+ {
+ "$ref": "#/833"
+ },
+ {
+ "$ref": "#/834"
+ },
+ {
+ "$ref": "#/835"
+ },
+ {
+ "$ref": "#/836"
+ },
+ {
+ "$ref": "#/837"
+ },
+ {
+ "$ref": "#/838"
+ },
+ {
+ "$ref": "#/839"
+ },
+ {
+ "$ref": "#/840"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupSetInfo",
+ "properties": {
+ "backupSetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Id for the set of backup files"
+ },
+ "firstLsn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "First log sequence number of the backup file"
+ },
+ "lastLsn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Last log sequence number of the backup file"
+ },
+ "lastModifiedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Last modified time of the backup file in share location"
+ },
+ "backupType": {
+ "type": {
+ "$ref": "#/850"
+ },
+ "flags": 0,
+ "description": "Enum of the different backup types"
+ },
+ "listOfBackupFiles": {
+ "type": {
+ "$ref": "#/860"
+ },
+ "flags": 0,
+ "description": "List of files in the backup set"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database to which the backup set belongs"
+ },
+ "backupStartDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date and time that the backup operation began"
+ },
+ "backupFinishedDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date and time that the backup operation finished"
+ },
+ "isBackupRestored": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether the backup set is restored or not"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Database"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TransactionLog"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "File"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DifferentialDatabase"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DifferentialFile"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Partial"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DifferentialPartial"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/843"
+ },
+ {
+ "$ref": "#/844"
+ },
+ {
+ "$ref": "#/845"
+ },
+ {
+ "$ref": "#/846"
+ },
+ {
+ "$ref": "#/847"
+ },
+ {
+ "$ref": "#/848"
+ },
+ {
+ "$ref": "#/849"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupFileInfo",
+ "properties": {
+ "fileLocation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Location of the backup file in shared folder"
+ },
+ "familySequenceNumber": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Sequence number of the backup file in the backup set"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/859"
+ },
+ "flags": 0,
+ "description": "Status of the backup file during migration"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Arrived"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Queued"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uploading"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Uploaded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restoring"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restored"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Cancelled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/852"
+ },
+ {
+ "$ref": "#/853"
+ },
+ {
+ "$ref": "#/854"
+ },
+ {
+ "$ref": "#/855"
+ },
+ {
+ "$ref": "#/856"
+ },
+ {
+ "$ref": "#/857"
+ },
+ {
+ "$ref": "#/858"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/851"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/842"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMISyncTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/865"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlMISyncTaskOutputMigrationLevel",
+ "properties": {
+ "databaseCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Count of databases"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/874"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "sourceServerName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server name"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "targetServerName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server name"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "databaseErrorCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of database level errors"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/875"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/867"
+ },
+ {
+ "$ref": "#/868"
+ },
+ {
+ "$ref": "#/869"
+ },
+ {
+ "$ref": "#/870"
+ },
+ {
+ "$ref": "#/871"
+ },
+ {
+ "$ref": "#/872"
+ },
+ {
+ "$ref": "#/873"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/829"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.SqlServer.AzureSqlDbMI.Sync.LRS"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/879"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/999"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "task id"
+ },
+ "isCloneable": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "whether the task can be cloned or not"
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "DateTime in UTC when the task was created"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1000"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/882"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "validationOptions": {
+ "type": {
+ "$ref": "#/695"
+ },
+ "flags": 0,
+ "description": "Options for enabling various post migration validations. Available options, \n 1.) Data Integrity Check: Performs a checksum based comparison on source and target tables after the migration to ensure the correctness of the data. \n 2.) Schema Validation: Performs a thorough schema comparison between the source and target tables and provides a list of differences between the source and target database, 3.) Query Analysis: Executes a set of queries picked up automatically either from the Query Plan Cache or Query Store and execute them and compares the execution time between the source and target database."
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date and time relative to UTC when the migration was started on"
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbDatabaseInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of target database. Note: Target database will be truncated before starting migration."
+ },
+ "makeSourceDbReadOnly": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to set database read only before migration"
+ },
+ "tableMap": {
+ "type": {
+ "$ref": "#/881"
+ },
+ "flags": 0,
+ "description": "Mapping of source to target tables"
+ },
+ "schemaSetting": {
+ "type": {
+ "$ref": "#/612"
+ },
+ "flags": 0,
+ "description": "Settings selected for DB schema migration."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "id of the database"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbDatabaseInputTableMap",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/880"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelOutput": {
+ "$ref": "#/884"
+ },
+ "ErrorOutput": {
+ "$ref": "#/902"
+ },
+ "MigrationDatabaseLevelValidationOutput": {
+ "$ref": "#/904"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/942"
+ },
+ "MigrationValidationOutput": {
+ "$ref": "#/977"
+ },
+ "TableLevelOutput": {
+ "$ref": "#/989"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the item"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/892"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/899"
+ },
+ "flags": 2,
+ "description": "Migration stage that this database is in"
+ },
+ "statusMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Status message"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "numberOfObjects": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of objects"
+ },
+ "numberOfObjectsCompleted": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of successfully completed objects"
+ },
+ "errorCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of database/object errors."
+ },
+ "errorPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all errors of the item"
+ },
+ "resultPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all sub-tem results of the item"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/900"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings."
+ },
+ "objectSummary": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Summary of object results in the migration"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/901"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/885"
+ },
+ {
+ "$ref": "#/886"
+ },
+ {
+ "$ref": "#/887"
+ },
+ {
+ "$ref": "#/888"
+ },
+ {
+ "$ref": "#/889"
+ },
+ {
+ "$ref": "#/890"
+ },
+ {
+ "$ref": "#/891"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialize"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Backup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FileCopy"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/893"
+ },
+ {
+ "$ref": "#/894"
+ },
+ {
+ "$ref": "#/895"
+ },
+ {
+ "$ref": "#/896"
+ },
+ {
+ "$ref": "#/897"
+ },
+ {
+ "$ref": "#/898"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/903"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "migrationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration Identifier"
+ },
+ "sourceDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the source database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the target database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Validation start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Validation end time"
+ },
+ "dataIntegrityValidationResult": {
+ "type": {
+ "$ref": "#/905"
+ },
+ "flags": 2,
+ "description": "Provides data integrity validation result between the source and target tables that are migrated."
+ },
+ "schemaValidationResult": {
+ "type": {
+ "$ref": "#/912"
+ },
+ "flags": 2,
+ "description": "Provides schema comparison result between source and target database"
+ },
+ "queryAnalysisValidationResult": {
+ "type": {
+ "$ref": "#/926"
+ },
+ "flags": 2,
+ "description": "Results of some of the query execution result between source and target database"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/940"
+ },
+ "flags": 2,
+ "description": "Current status of validation at the database level"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/941"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataIntegrityValidationResult",
+ "properties": {
+ "failedObjects": {
+ "type": {
+ "$ref": "#/906"
+ },
+ "flags": 0,
+ "description": "List of failed table names of source and target pair"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/907"
+ },
+ "flags": 0,
+ "description": "List of errors that happened while performing data integrity validation"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataIntegrityValidationResultFailedObjects",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidationError",
+ "properties": {
+ "text": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Error Text"
+ },
+ "severity": {
+ "type": {
+ "$ref": "#/911"
+ },
+ "flags": 0,
+ "description": "Severity of the error"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Message"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/908"
+ },
+ {
+ "$ref": "#/909"
+ },
+ {
+ "$ref": "#/910"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SchemaComparisonValidationResult",
+ "properties": {
+ "schemaDifferences": {
+ "type": {
+ "$ref": "#/913"
+ },
+ "flags": 0,
+ "description": "List of schema differences between the source and target databases"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/907"
+ },
+ "flags": 0,
+ "description": "List of errors that happened while performing schema compare validation"
+ },
+ "sourceDatabaseObjectCount": {
+ "type": {
+ "$ref": "#/924"
+ },
+ "flags": 0,
+ "description": "Count of source database objects"
+ },
+ "targetDatabaseObjectCount": {
+ "type": {
+ "$ref": "#/925"
+ },
+ "flags": 0,
+ "description": "Count of target database objects"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SchemaComparisonValidationResultType",
+ "properties": {
+ "objectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the object that has the difference"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/919"
+ },
+ "flags": 0,
+ "description": "Type of the object that has the difference. e.g (Table/View/StoredProcedure)"
+ },
+ "updateAction": {
+ "type": {
+ "$ref": "#/923"
+ },
+ "flags": 0,
+ "description": "Update action type with respect to target"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StoredProcedures"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Table"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "View"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Function"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/914"
+ },
+ {
+ "$ref": "#/915"
+ },
+ {
+ "$ref": "#/916"
+ },
+ {
+ "$ref": "#/917"
+ },
+ {
+ "$ref": "#/918"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DeletedOnTarget"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ChangedOnTarget"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AddedOnTarget"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/920"
+ },
+ {
+ "$ref": "#/921"
+ },
+ {
+ "$ref": "#/922"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SchemaComparisonValidationResultSourceDatabaseObjectCount",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/7"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SchemaComparisonValidationResultTargetDatabaseObjectCount",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/7"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryAnalysisValidationResult",
+ "properties": {
+ "queryResults": {
+ "type": {
+ "$ref": "#/927"
+ },
+ "flags": 0,
+ "description": "List of queries executed and it's execution results in source and target"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/907"
+ },
+ "flags": 0,
+ "description": "Errors that are part of the execution"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "QueryExecutionResult",
+ "properties": {
+ "queryText": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Query text retrieved from the source server"
+ },
+ "statementsInBatch": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Total no. of statements in the batch"
+ },
+ "sourceResult": {
+ "type": {
+ "$ref": "#/928"
+ },
+ "flags": 0,
+ "description": "Query analysis result from the source"
+ },
+ "targetResult": {
+ "type": {
+ "$ref": "#/928"
+ },
+ "flags": 0,
+ "description": "Query analysis result from the target"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecutionStatistics",
+ "properties": {
+ "executionCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "No. of query executions"
+ },
+ "cpuTimeMs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "CPU Time in millisecond(s) for the query execution"
+ },
+ "elapsedTimeMs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Time taken in millisecond(s) for executing the query"
+ },
+ "waitStats": {
+ "type": {
+ "$ref": "#/930"
+ },
+ "flags": 0,
+ "description": "Dictionary of sql query execution wait types and the respective statistics"
+ },
+ "hasErrors": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Indicates whether the query resulted in an error"
+ },
+ "sqlErrors": {
+ "type": {
+ "$ref": "#/931"
+ },
+ "flags": 0,
+ "description": "List of sql Errors"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "WaitStatistics",
+ "properties": {
+ "waitType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Type of the Wait"
+ },
+ "waitTimeMs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Total wait time in millisecond(s)"
+ },
+ "waitCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Total no. of waits"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ExecutionStatisticsWaitStats",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/929"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithIssues"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/932"
+ },
+ {
+ "$ref": "#/933"
+ },
+ {
+ "$ref": "#/934"
+ },
+ {
+ "$ref": "#/935"
+ },
+ {
+ "$ref": "#/936"
+ },
+ {
+ "$ref": "#/937"
+ },
+ {
+ "$ref": "#/938"
+ },
+ {
+ "$ref": "#/939"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationDatabaseLevelValidationOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "durationInSeconds": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Duration of task execution in seconds."
+ },
+ "status": {
+ "type": {
+ "$ref": "#/953"
+ },
+ "flags": 2,
+ "description": "Current status of migration"
+ },
+ "statusMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration status message"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "databases": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Selected databases as a map from database name to database id"
+ },
+ "databaseSummary": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Summary of database results in the migration"
+ },
+ "migrationValidationResult": {
+ "type": {
+ "$ref": "#/954"
+ },
+ "flags": 0,
+ "description": "Migration Validation Results"
+ },
+ "migrationReportResult": {
+ "type": {
+ "$ref": "#/497"
+ },
+ "flags": 0,
+ "description": "Migration Report Result, provides unique url for downloading your migration report."
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/975"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/976"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Connecting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SourceAndTargetSelected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SelectLogins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Configured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/943"
+ },
+ {
+ "$ref": "#/944"
+ },
+ {
+ "$ref": "#/945"
+ },
+ {
+ "$ref": "#/946"
+ },
+ {
+ "$ref": "#/947"
+ },
+ {
+ "$ref": "#/948"
+ },
+ {
+ "$ref": "#/949"
+ },
+ {
+ "$ref": "#/950"
+ },
+ {
+ "$ref": "#/951"
+ },
+ {
+ "$ref": "#/952"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationValidationResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration validation result identifier"
+ },
+ "migrationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration Identifier"
+ },
+ "summaryResults": {
+ "type": {
+ "$ref": "#/965"
+ },
+ "flags": 0,
+ "description": "Validation summary results for each database"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/974"
+ },
+ "flags": 2,
+ "description": "Current status of validation at the migration level. Status from the database validation result status will be aggregated here."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationValidationDatabaseSummaryResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "migrationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration Identifier"
+ },
+ "sourceDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the source database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the target database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Validation start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Validation end time"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/964"
+ },
+ "flags": 2,
+ "description": "Current status of validation at the database level"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithIssues"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/956"
+ },
+ {
+ "$ref": "#/957"
+ },
+ {
+ "$ref": "#/958"
+ },
+ {
+ "$ref": "#/959"
+ },
+ {
+ "$ref": "#/960"
+ },
+ {
+ "$ref": "#/961"
+ },
+ {
+ "$ref": "#/962"
+ },
+ {
+ "$ref": "#/963"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationValidationResultSummaryResults",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/955"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithIssues"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/966"
+ },
+ {
+ "$ref": "#/967"
+ },
+ {
+ "$ref": "#/968"
+ },
+ {
+ "$ref": "#/969"
+ },
+ {
+ "$ref": "#/970"
+ },
+ {
+ "$ref": "#/971"
+ },
+ {
+ "$ref": "#/972"
+ },
+ {
+ "$ref": "#/973"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutputValidationResult",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration validation result identifier"
+ },
+ "migrationId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration Identifier"
+ },
+ "summaryResults": {
+ "type": {
+ "$ref": "#/978"
+ },
+ "flags": 0,
+ "description": "Validation summary results for each database"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/987"
+ },
+ "flags": 2,
+ "description": "Current status of validation at the migration level. Status from the database validation result status will be aggregated here."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/988"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationValidationResultSummaryResults",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/955"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialized"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithIssues"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/979"
+ },
+ {
+ "$ref": "#/980"
+ },
+ {
+ "$ref": "#/981"
+ },
+ {
+ "$ref": "#/982"
+ },
+ {
+ "$ref": "#/983"
+ },
+ {
+ "$ref": "#/984"
+ },
+ {
+ "$ref": "#/985"
+ },
+ {
+ "$ref": "#/986"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationValidationOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSqlServerSqlDbTaskOutputTableLevel",
+ "properties": {
+ "objectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the item"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/997"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "statusMessage": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Status message"
+ },
+ "itemsCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of items"
+ },
+ "itemsCompletedCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of successfully completed items"
+ },
+ "errorPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all errors of the item"
+ },
+ "resultPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Wildcard string prefix to use for querying all sub-tem results of the item"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/998"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/990"
+ },
+ {
+ "$ref": "#/991"
+ },
+ {
+ "$ref": "#/992"
+ },
+ {
+ "$ref": "#/993"
+ },
+ {
+ "$ref": "#/994"
+ },
+ {
+ "$ref": "#/995"
+ },
+ {
+ "$ref": "#/996"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TableLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/883"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.SqlServer.SqlDb"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSsisTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1002"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1048"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1049"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSsisTaskInput",
+ "properties": {
+ "ssisMigrationInfo": {
+ "type": {
+ "$ref": "#/1003"
+ },
+ "flags": 1,
+ "description": "SSIS package migration information."
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SsisMigrationInfo",
+ "properties": {
+ "ssisStoreType": {
+ "type": {
+ "$ref": "#/1005"
+ },
+ "flags": 0,
+ "description": "The SSIS store type of source, only SSIS catalog is supported now in DMS (classic)"
+ },
+ "projectOverwriteOption": {
+ "type": {
+ "$ref": "#/1008"
+ },
+ "flags": 0,
+ "description": "The overwrite option for the SSIS project migration"
+ },
+ "environmentOverwriteOption": {
+ "type": {
+ "$ref": "#/1011"
+ },
+ "flags": 0,
+ "description": "The overwrite option for the SSIS environment migration"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SsisCatalog"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1004"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ignore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Overwrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1006"
+ },
+ {
+ "$ref": "#/1007"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Ignore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Overwrite"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1009"
+ },
+ {
+ "$ref": "#/1010"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateSsisTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "MigrationLevelOutput": {
+ "$ref": "#/1013"
+ },
+ "SsisProjectLevelOutput": {
+ "$ref": "#/1032"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSsisTaskOutputMigrationLevel",
+ "properties": {
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/1024"
+ },
+ "flags": 2,
+ "description": "Current status of migration"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/1025"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings."
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/1030"
+ },
+ "flags": 2,
+ "description": "Stage of SSIS migration."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1031"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Connecting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SourceAndTargetSelected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SelectLogins"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Configured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Running"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Error"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1014"
+ },
+ {
+ "$ref": "#/1015"
+ },
+ {
+ "$ref": "#/1016"
+ },
+ {
+ "$ref": "#/1017"
+ },
+ {
+ "$ref": "#/1018"
+ },
+ {
+ "$ref": "#/1019"
+ },
+ {
+ "$ref": "#/1020"
+ },
+ {
+ "$ref": "#/1021"
+ },
+ {
+ "$ref": "#/1022"
+ },
+ {
+ "$ref": "#/1023"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialize"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1026"
+ },
+ {
+ "$ref": "#/1027"
+ },
+ {
+ "$ref": "#/1028"
+ },
+ {
+ "$ref": "#/1029"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSsisTaskOutputProjectLevel",
+ "properties": {
+ "folderName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the folder"
+ },
+ "projectName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the project"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/1040"
+ },
+ "flags": 2,
+ "description": "Current state of migration"
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/1045"
+ },
+ "flags": 2,
+ "description": "Stage of SSIS migration."
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration progress message"
+ },
+ "exceptionsAndWarnings": {
+ "type": {
+ "$ref": "#/1046"
+ },
+ "flags": 2,
+ "description": "Migration exceptions and warnings"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1047"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1033"
+ },
+ {
+ "$ref": "#/1034"
+ },
+ {
+ "$ref": "#/1035"
+ },
+ {
+ "$ref": "#/1036"
+ },
+ {
+ "$ref": "#/1037"
+ },
+ {
+ "$ref": "#/1038"
+ },
+ {
+ "$ref": "#/1039"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initialize"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1041"
+ },
+ {
+ "$ref": "#/1042"
+ },
+ {
+ "$ref": "#/1043"
+ },
+ {
+ "$ref": "#/1044"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SsisProjectLevelOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1012"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migrate.Ssis"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1051"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1095"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "createdOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "DateTime in UTC when the task was created"
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Task id"
+ },
+ "isCloneable": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "whether the task can be cloned or not"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1096"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbTaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/1058"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "encryptedKeyForSecureFields": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "encrypted key for secure fields"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Migration start time"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbDatabaseInput",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of source database"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Id of the source database"
+ },
+ "targetDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of target database"
+ },
+ "schemaSetting": {
+ "type": {
+ "$ref": "#/1053"
+ },
+ "flags": 0,
+ "description": "Database schema migration settings"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SchemaMigrationSetting",
+ "properties": {
+ "schemaOption": {
+ "type": {
+ "$ref": "#/1057"
+ },
+ "flags": 0,
+ "description": "Option on how to migrate the schema"
+ },
+ "fileId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Resource Identifier of a file resource containing the uploaded schema file"
+ },
+ "fileName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the file resource containing the uploaded schema file"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ExtractFromSource"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UseStorageFile"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1054"
+ },
+ {
+ "$ref": "#/1055"
+ },
+ {
+ "$ref": "#/1056"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1052"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbTaskOutput",
+ "discriminator": "resultType",
+ "baseProperties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ }
+ },
+ "elements": {
+ "DatabaseLevelOutput": {
+ "$ref": "#/1060"
+ },
+ "ErrorOutput": {
+ "$ref": "#/1081"
+ },
+ "MigrationLevelOutput": {
+ "$ref": "#/1083"
+ },
+ "SchemaErrorOutput": {
+ "$ref": "#/1093"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the database"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/1068"
+ },
+ "flags": 2,
+ "description": "State of the schema migration for this database"
+ },
+ "stage": {
+ "type": {
+ "$ref": "#/1079"
+ },
+ "flags": 2,
+ "description": "Schema migration stage for this database"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "databaseErrorResultPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Prefix string to use for querying errors for this database"
+ },
+ "schemaErrorResultPrefix": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Prefix string to use for querying schema errors for this database"
+ },
+ "numberOfSuccessfulOperations": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of successful operations for this database"
+ },
+ "numberOfFailedOperations": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of failed operations for this database"
+ },
+ "fileId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Identifier for the file resource containing the schema of this database"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1080"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1061"
+ },
+ {
+ "$ref": "#/1062"
+ },
+ {
+ "$ref": "#/1063"
+ },
+ {
+ "$ref": "#/1064"
+ },
+ {
+ "$ref": "#/1065"
+ },
+ {
+ "$ref": "#/1066"
+ },
+ {
+ "$ref": "#/1067"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidatingInputs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CollectingObjects"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DownloadingScript"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GeneratingScript"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UploadingScript"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DeployingSchema"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CompletedWithWarnings"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1069"
+ },
+ {
+ "$ref": "#/1070"
+ },
+ {
+ "$ref": "#/1071"
+ },
+ {
+ "$ref": "#/1072"
+ },
+ {
+ "$ref": "#/1073"
+ },
+ {
+ "$ref": "#/1074"
+ },
+ {
+ "$ref": "#/1075"
+ },
+ {
+ "$ref": "#/1076"
+ },
+ {
+ "$ref": "#/1077"
+ },
+ {
+ "$ref": "#/1078"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DatabaseLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlTaskOutputError",
+ "properties": {
+ "error": {
+ "type": {
+ "$ref": "#/117"
+ },
+ "flags": 2,
+ "description": "Migration error"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1082"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ErrorOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel",
+ "properties": {
+ "state": {
+ "type": {
+ "$ref": "#/1091"
+ },
+ "flags": 2,
+ "description": "Overall state of the schema migration"
+ },
+ "startedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration start time"
+ },
+ "endedOn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Migration end time"
+ },
+ "sourceServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server version"
+ },
+ "sourceServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Source server brand version"
+ },
+ "targetServerVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server version"
+ },
+ "targetServerBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Target server brand version"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1092"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Warning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skipped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Stopped"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1084"
+ },
+ {
+ "$ref": "#/1085"
+ },
+ {
+ "$ref": "#/1086"
+ },
+ {
+ "$ref": "#/1087"
+ },
+ {
+ "$ref": "#/1088"
+ },
+ {
+ "$ref": "#/1089"
+ },
+ {
+ "$ref": "#/1090"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrationLevelOutput"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrateSchemaSqlServerSqlDbTaskOutputError",
+ "properties": {
+ "commandText": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Schema command which failed"
+ },
+ "errorText": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Reason of failure"
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1094"
+ },
+ "flags": 1,
+ "description": "Result type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SchemaErrorOutput"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1059"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MigrateSchemaSqlServerSqlDb"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CheckOCIDriverTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1098"
+ },
+ "flags": 0,
+ "description": "Input for the service task to check for OCI drivers."
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1103"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1104"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CheckOCIDriverTaskInput",
+ "properties": {
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Version of the source server to check against. Optional."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CheckOCIDriverTaskOutput",
+ "properties": {
+ "installedDriver": {
+ "type": {
+ "$ref": "#/1100"
+ },
+ "flags": 0,
+ "description": "Information about the installed driver if found and valid."
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/1102"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OracleOCIDriverInfo",
+ "properties": {
+ "driverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the driver package"
+ },
+ "driverSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The size in bytes of the driver package"
+ },
+ "archiveChecksum": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The MD5 Base64 encoded checksum for the driver package."
+ },
+ "oracleChecksum": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The checksum for the driver package provided by Oracle."
+ },
+ "assemblyVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Version listed in the OCI assembly 'oci.dll'"
+ },
+ "supportedOracleVersions": {
+ "type": {
+ "$ref": "#/1101"
+ },
+ "flags": 2,
+ "description": "List of Oracle database versions supported by this driver. Only major minor of the version is listed."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1099"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Service.Check.OCI"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InstallOCIDriverTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1106"
+ },
+ "flags": 0,
+ "description": "Input for the service task to install an OCI driver."
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1109"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1110"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InstallOCIDriverTaskInput",
+ "properties": {
+ "driverPackageName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the uploaded driver package to install."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InstallOCIDriverTaskOutput",
+ "properties": {
+ "validationErrors": {
+ "type": {
+ "$ref": "#/1108"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1107"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Service.Install.OCI"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UploadOCIDriverTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1112"
+ },
+ "flags": 0,
+ "description": "Input for the service task to upload an OCI driver."
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1115"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1116"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UploadOCIDriverTaskInput",
+ "properties": {
+ "driverShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "File share information for the OCI driver archive."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UploadOCIDriverTaskOutput",
+ "properties": {
+ "driverPackageName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the driver package that was validated and uploaded."
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/1114"
+ },
+ "flags": 2,
+ "description": "Validation errors"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1113"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Service.Upload.OCI"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMongoDbTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/380"
+ },
+ "flags": 0,
+ "description": "Describes how a MongoDB data migration should be performed"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1137"
+ },
+ "flags": 2,
+ "description": "An array containing a single MongoDbMigrationProgress object"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1138"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbMigrationProgress",
+ "properties": {
+ "databases": {
+ "type": {
+ "$ref": "#/1119"
+ },
+ "flags": 0,
+ "description": "The progress of the databases in the migration. The keys are the names of the databases"
+ },
+ "bytesCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of document bytes copied during the Copying stage"
+ },
+ "documentsCopied": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of documents copied during the Copying stage"
+ },
+ "elapsedTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)"
+ },
+ "errors": {
+ "type": {
+ "$ref": "#/1120"
+ },
+ "flags": 1,
+ "description": "The errors and warnings that have occurred for the current object. The keys are the error codes."
+ },
+ "eventsPending": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events awaiting replay"
+ },
+ "eventsReplayed": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The number of oplog events replayed so far"
+ },
+ "lastEventTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event received, or null if no oplog event has been received yet"
+ },
+ "lastReplayTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "qualifiedName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null."
+ },
+ "resultType": {
+ "type": {
+ "$ref": "#/1124"
+ },
+ "flags": 1,
+ "description": "The type of progress object"
+ },
+ "state": {
+ "type": {
+ "$ref": "#/1136"
+ },
+ "flags": 1
+ },
+ "totalBytes": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown"
+ },
+ "totalDocuments": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbMigrationProgressDatabases",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/435"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbProgressErrors",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/393"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Migration"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Database"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Collection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1121"
+ },
+ {
+ "$ref": "#/1122"
+ },
+ {
+ "$ref": "#/1123"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotStarted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidatingInput"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Initializing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Restarting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Copying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InitialReplay"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Replaying"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Finalizing"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Complete"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1125"
+ },
+ {
+ "$ref": "#/1126"
+ },
+ {
+ "$ref": "#/1127"
+ },
+ {
+ "$ref": "#/1128"
+ },
+ {
+ "$ref": "#/1129"
+ },
+ {
+ "$ref": "#/1130"
+ },
+ {
+ "$ref": "#/1131"
+ },
+ {
+ "$ref": "#/1132"
+ },
+ {
+ "$ref": "#/1133"
+ },
+ {
+ "$ref": "#/1134"
+ },
+ {
+ "$ref": "#/1135"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1118"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Validate.MongoDb"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateOracleAzureDbForPostgreSqlSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/562"
+ },
+ "flags": 0,
+ "description": "Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1142"
+ },
+ "flags": 2,
+ "description": "An array containing a single validation error response object"
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1143"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateOracleAzureDbPostgreSqlSyncTaskOutput",
+ "properties": {
+ "validationErrors": {
+ "type": {
+ "$ref": "#/1141"
+ },
+ "flags": 2,
+ "description": "Errors associated with a selected database object"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1140"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Validate.Oracle.AzureDbPostgreSql.Sync"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlMITaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1145"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1167"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1168"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlMITaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/1146"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "selectedLogins": {
+ "type": {
+ "$ref": "#/1147"
+ },
+ "flags": 0,
+ "description": "Logins to migrate"
+ },
+ "backupFileShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Backup file share information for all selected databases."
+ },
+ "backupBlobShare": {
+ "type": {
+ "$ref": "#/743"
+ },
+ "flags": 1,
+ "description": "SAS URI of Azure Storage Account Container to be used for storing backup files."
+ },
+ "backupMode": {
+ "type": {
+ "$ref": "#/1150"
+ },
+ "flags": 0,
+ "description": "Backup Mode to specify whether to use existing backup or create new backup."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/738"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateBackup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ExistingBackup"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1148"
+ },
+ {
+ "$ref": "#/1149"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlMITaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Result identifier"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of database"
+ },
+ "restoreDatabaseNameErrors": {
+ "type": {
+ "$ref": "#/1152"
+ },
+ "flags": 2,
+ "description": "Errors associated with the RestoreDatabaseName"
+ },
+ "backupFolderErrors": {
+ "type": {
+ "$ref": "#/1153"
+ },
+ "flags": 2,
+ "description": "Errors associated with the BackupFolder path"
+ },
+ "backupShareCredentialsErrors": {
+ "type": {
+ "$ref": "#/1154"
+ },
+ "flags": 2,
+ "description": "Errors associated with backup share user name and password credentials"
+ },
+ "backupStorageAccountErrors": {
+ "type": {
+ "$ref": "#/1155"
+ },
+ "flags": 2,
+ "description": "Errors associated with the storage account provided."
+ },
+ "existingBackupErrors": {
+ "type": {
+ "$ref": "#/1156"
+ },
+ "flags": 2,
+ "description": "Errors associated with existing backup files."
+ },
+ "databaseBackupInfo": {
+ "type": {
+ "$ref": "#/1157"
+ },
+ "flags": 0,
+ "description": "Information about backup files when existing backup mode is used."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseBackupInfo",
+ "properties": {
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database name."
+ },
+ "backupType": {
+ "type": {
+ "$ref": "#/1165"
+ },
+ "flags": 2,
+ "description": "Backup Type."
+ },
+ "backupFiles": {
+ "type": {
+ "$ref": "#/1166"
+ },
+ "flags": 2,
+ "description": "The list of backup files for the current database."
+ },
+ "position": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Position of current database backup in the file."
+ },
+ "isDamaged": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Database was damaged when backed up, but the backup operation was requested to continue despite errors."
+ },
+ "isCompressed": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 2,
+ "description": "Whether the backup set is compressed"
+ },
+ "familyCount": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Number of files in the backup set."
+ },
+ "backupFinishDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Date and time when the backup operation finished."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Database"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TransactionLog"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "File"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DifferentialDatabase"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DifferentialFile"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Partial"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DifferentialPartial"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1158"
+ },
+ {
+ "$ref": "#/1159"
+ },
+ {
+ "$ref": "#/1160"
+ },
+ {
+ "$ref": "#/1161"
+ },
+ {
+ "$ref": "#/1162"
+ },
+ {
+ "$ref": "#/1163"
+ },
+ {
+ "$ref": "#/1164"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1151"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidateMigrationInput.SqlServer.AzureSqlDbMI"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlMISyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1170"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1174"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1175"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlMISyncTaskInput",
+ "properties": {
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/1171"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ },
+ "backupFileShare": {
+ "type": {
+ "$ref": "#/333"
+ },
+ "flags": 0,
+ "description": "Backup file share information for all selected databases."
+ },
+ "storageResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Fully qualified resourceId of storage"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Connection information for source SQL Server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/306"
+ },
+ "flags": 1,
+ "description": "Connection information for Azure SQL Database Managed Instance"
+ },
+ "azureApp": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 1,
+ "description": "Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/738"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlMISyncTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database identifier"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of database"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/1173"
+ },
+ "flags": 2,
+ "description": "Errors associated with a selected database object"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1172"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateMigrationInputSqlServerSqlDbSyncTaskProperties",
+ "properties": {
+ "input": {
+ "type": {
+ "$ref": "#/1177"
+ },
+ "flags": 0,
+ "description": "Task input"
+ },
+ "output": {
+ "type": {
+ "$ref": "#/1181"
+ },
+ "flags": 2,
+ "description": "Task output. This is ignored if submitted."
+ },
+ "taskType": {
+ "type": {
+ "$ref": "#/1182"
+ },
+ "flags": 1,
+ "description": "Task type."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateSyncMigrationInputSqlServerTaskInput",
+ "properties": {
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to source SQL server"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/215"
+ },
+ "flags": 1,
+ "description": "Information for connecting to target"
+ },
+ "selectedDatabases": {
+ "type": {
+ "$ref": "#/1178"
+ },
+ "flags": 1,
+ "description": "Databases to migrate"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/689"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateSyncMigrationInputSqlServerTaskOutput",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Database identifier"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of database"
+ },
+ "validationErrors": {
+ "type": {
+ "$ref": "#/1180"
+ },
+ "flags": 2,
+ "description": "Errors associated with a selected database object"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/117"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1179"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ValidateMigrationInput.SqlServer.SqlDb.Sync"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/services/projects/tasks@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/92"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/services/serviceTasks"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/services/serviceTasks",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1184"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/1185"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "HTTP strong entity tag value. This is ignored if submitted."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Custom task properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/services/serviceTasks@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/1186"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/services/projects"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/services/projects",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1188"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/1189"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/1191"
+ },
+ "flags": 0,
+ "description": "Project properties"
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "HTTP strong entity tag value. This is ignored if submitted."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/1255"
+ },
+ "flags": 0,
+ "description": "Dictionary of "
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProjectProperties",
+ "properties": {
+ "sourcePlatform": {
+ "type": {
+ "$ref": "#/1197"
+ },
+ "flags": 1,
+ "description": "Source platform for the project"
+ },
+ "azureAuthenticationInfo": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 0,
+ "description": "Field that defines the Azure active directory application info, used to connect to the target Azure resource"
+ },
+ "targetPlatform": {
+ "type": {
+ "$ref": "#/1204"
+ },
+ "flags": 1,
+ "description": "Target platform for the project"
+ },
+ "creationTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "UTC Date and time when project was created"
+ },
+ "sourceConnectionInfo": {
+ "type": {
+ "$ref": "#/1205"
+ },
+ "flags": 0,
+ "description": "Information for connecting to source"
+ },
+ "targetConnectionInfo": {
+ "type": {
+ "$ref": "#/1205"
+ },
+ "flags": 0,
+ "description": "Information for connecting to target"
+ },
+ "databasesInfo": {
+ "type": {
+ "$ref": "#/1251"
+ },
+ "flags": 0,
+ "description": "List of DatabaseInfo"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/1254"
+ },
+ "flags": 2,
+ "description": "The project's provisioning state"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MySQL"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PostgreSql"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDb"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1192"
+ },
+ {
+ "$ref": "#/1193"
+ },
+ {
+ "$ref": "#/1194"
+ },
+ {
+ "$ref": "#/1195"
+ },
+ {
+ "$ref": "#/1196"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLDB"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SQLMI"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureDbForMySql"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureDbForPostgreSql"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDb"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1198"
+ },
+ {
+ "$ref": "#/1199"
+ },
+ {
+ "$ref": "#/1200"
+ },
+ {
+ "$ref": "#/1201"
+ },
+ {
+ "$ref": "#/1202"
+ },
+ {
+ "$ref": "#/1203"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "ConnectionInfo",
+ "discriminator": "type",
+ "baseProperties": {
+ "userName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User name"
+ },
+ "password": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Password credential."
+ }
+ },
+ "elements": {
+ "MiSqlConnectionInfo": {
+ "$ref": "#/1206"
+ },
+ "MongoDbConnectionInfo": {
+ "$ref": "#/1208"
+ },
+ "MySqlConnectionInfo": {
+ "$ref": "#/1216"
+ },
+ "OracleConnectionInfo": {
+ "$ref": "#/1224"
+ },
+ "PostgreSqlConnectionInfo": {
+ "$ref": "#/1232"
+ },
+ "SqlConnectionInfo": {
+ "$ref": "#/1240"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MiSqlConnectionInfo",
+ "properties": {
+ "managedInstanceResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Resource id for Azure SQL database Managed instance"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1207"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MiSqlConnectionInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MongoDbConnectionInfo",
+ "properties": {
+ "connectionString": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties"
+ },
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data source"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "serverBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server brand version"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "name of the server"
+ },
+ "trustServerCertificate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to trust the server certificate"
+ },
+ "enforceSSL": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "port for server"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/1214"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1215"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1209"
+ },
+ {
+ "$ref": "#/1210"
+ },
+ {
+ "$ref": "#/1211"
+ },
+ {
+ "$ref": "#/1212"
+ },
+ {
+ "$ref": "#/1213"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MongoDbConnectionInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MySqlConnectionInfo",
+ "properties": {
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the server"
+ },
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data source"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "Port for Server"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/1222"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1223"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1217"
+ },
+ {
+ "$ref": "#/1218"
+ },
+ {
+ "$ref": "#/1219"
+ },
+ {
+ "$ref": "#/1220"
+ },
+ {
+ "$ref": "#/1221"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MySqlConnectionInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OracleConnectionInfo",
+ "properties": {
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "EZConnect or TNSName connection string."
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "name of the server"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "port for server"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/1230"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1231"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1225"
+ },
+ {
+ "$ref": "#/1226"
+ },
+ {
+ "$ref": "#/1227"
+ },
+ {
+ "$ref": "#/1228"
+ },
+ {
+ "$ref": "#/1229"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OracleConnectionInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PostgreSqlConnectionInfo",
+ "properties": {
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the server"
+ },
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Data source"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "databaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Name of the database"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "Port for Server"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "trustServerCertificate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to trust the server certificate"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "serverBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server brand version"
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/1238"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1239"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1233"
+ },
+ {
+ "$ref": "#/1234"
+ },
+ {
+ "$ref": "#/1235"
+ },
+ {
+ "$ref": "#/1236"
+ },
+ {
+ "$ref": "#/1237"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PostgreSqlConnectionInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SqlConnectionInfo",
+ "properties": {
+ "dataSource": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Data source in the format Protocol:MachineName\\SQLServerInstanceName,PortNumber"
+ },
+ "serverName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "name of the server"
+ },
+ "port": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Port for Server"
+ },
+ "serverVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server version"
+ },
+ "serverBrandVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "server brand version"
+ },
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Represents the ID of an HTTP resource represented by an Azure resource provider."
+ },
+ "authentication": {
+ "type": {
+ "$ref": "#/1246"
+ },
+ "flags": 0,
+ "description": "Authentication type to use for connection"
+ },
+ "encryptConnection": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to encrypt the connection"
+ },
+ "additionalSettings": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Additional connection settings"
+ },
+ "trustServerCertificate": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "Whether to trust the server certificate"
+ },
+ "platform": {
+ "type": {
+ "$ref": "#/1248"
+ },
+ "flags": 0,
+ "description": "Server platform type for connection"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1249"
+ },
+ "flags": 1,
+ "description": "Type of connection info"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "WindowsAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlAuthentication"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryIntegrated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectoryPassword"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1241"
+ },
+ {
+ "$ref": "#/1242"
+ },
+ {
+ "$ref": "#/1243"
+ },
+ {
+ "$ref": "#/1244"
+ },
+ {
+ "$ref": "#/1245"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlOnPrem"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1247"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SqlConnectionInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatabaseInfo",
+ "properties": {
+ "sourceDatabaseName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Name of the database"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1250"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1252"
+ },
+ {
+ "$ref": "#/1253"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/services/projects@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/1190"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataMigration/services/projects/files"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataMigration/services/projects/files",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1257"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/1258"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "HTTP strong entity tag value. This is ignored if submitted."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/1260"
+ },
+ "flags": 0,
+ "description": "Custom file properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProjectFileProperties",
+ "properties": {
+ "extension": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Optional File extension. If submitted it should not have a leading period and must match the extension from filePath."
+ },
+ "filePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Relative path of this file resource. This property can be set when creating or updating the file resource."
+ },
+ "lastModified": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Modification DateTime."
+ },
+ "mediaType": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "File content type. This property can be modified to reflect the file content type."
+ },
+ "size": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "File size."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataMigration/services/projects/files@2025-03-15-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/1259"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MigrationOperationInput",
+ "properties": {
+ "migrationOperationId": {
+ "type": {
+ "$ref": "#/1263"
+ },
+ "flags": 0,
+ "description": "ID tracking migration operation."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancel",
+ "resourceType": "Microsoft.DataMigration/databaseMigrations",
+ "apiVersion": "2025-03-15-preview",
+ "input": {
+ "$ref": "#/1262"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cutover",
+ "resourceType": "Microsoft.DataMigration/databaseMigrations",
+ "apiVersion": "2025-03-15-preview",
+ "input": {
+ "$ref": "#/1262"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AuthenticationKeys",
+ "properties": {
+ "authKey1": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The first authentication key."
+ },
+ "authKey2": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The second authentication key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listAuthKeys",
+ "resourceType": "Microsoft.DataMigration/sqlMigrationServices",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1266"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RegenAuthKeys",
+ "properties": {
+ "keyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of authentication key to generate."
+ },
+ "authKey1": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The first authentication key."
+ },
+ "authKey2": {
+ "type": {
+ "$ref": "#/8"
+ },
+ "flags": 0,
+ "description": "The second authentication key."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "regenerateAuthKeys",
+ "resourceType": "Microsoft.DataMigration/sqlMigrationServices",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1268"
+ },
+ "input": {
+ "$ref": "#/1268"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DeleteNode",
+ "properties": {
+ "nodeName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of node to delete."
+ },
+ "integrationRuntimeName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The name of integration runtime."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "deleteNode",
+ "resourceType": "Microsoft.DataMigration/sqlMigrationServices",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1270"
+ },
+ "input": {
+ "$ref": "#/1270"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IntegrationRuntimeMonitoringData",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of Integration Runtime."
+ },
+ "nodes": {
+ "type": {
+ "$ref": "#/1275"
+ },
+ "flags": 2,
+ "description": "Integration Runtime node monitoring data."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NodeMonitoringData",
+ "properties": {
+ "additionalProperties": {
+ "type": {
+ "$ref": "#/1274"
+ },
+ "flags": 2,
+ "description": "Unmatched properties from the message are deserialized in this collection."
+ },
+ "nodeName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the integration runtime node."
+ },
+ "availableMemoryInMB": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Available memory (MB) on the integration runtime node."
+ },
+ "cpuUtilization": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "CPU percentage on the integration runtime node."
+ },
+ "concurrentJobsLimit": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Maximum concurrent jobs on the integration runtime node."
+ },
+ "concurrentJobsRunning": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "The number of jobs currently running on the integration runtime node."
+ },
+ "maxConcurrentJobs": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "The maximum concurrent jobs in this integration runtime."
+ },
+ "sentBytes": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Sent bytes on the integration runtime node."
+ },
+ "receivedBytes": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 2,
+ "description": "Received bytes on the integration runtime node."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NodeMonitoringDataAdditionalProperties",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/612"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/1273"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "listMonitoringData",
+ "resourceType": "Microsoft.DataMigration/sqlMigrationServices",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1272"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataMigrationServiceStatusResponse",
+ "properties": {
+ "agentVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The DMS instance agent version"
+ },
+ "agentConfiguration": {
+ "type": {
+ "$ref": "#/612"
+ },
+ "flags": 0,
+ "description": "Agent Configuration"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The machine-readable status, such as 'Initializing', 'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping', 'Starting', 'FailedToStart', 'FailedToStop' or 'Failed'"
+ },
+ "vmSize": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The services virtual machine size, such as 'Standard_D2_v2'"
+ },
+ "supportedTaskTypes": {
+ "type": {
+ "$ref": "#/1278"
+ },
+ "flags": 0,
+ "description": "The list of supported task types"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "checkStatus",
+ "resourceType": "Microsoft.DataMigration/services",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1277"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "start",
+ "resourceType": "Microsoft.DataMigration/services",
+ "apiVersion": "2025-03-15-preview"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stop",
+ "resourceType": "Microsoft.DataMigration/services",
+ "apiVersion": "2025-03-15-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NameAvailabilityRequest",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The proposed resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource type chain (e.g. virtualMachines/extensions)"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NameAvailabilityResponse",
+ "properties": {
+ "nameAvailable": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0,
+ "description": "If true, the name is valid and available. If false, 'reason' describes why not."
+ },
+ "reason": {
+ "type": {
+ "$ref": "#/1286"
+ },
+ "flags": 0,
+ "description": "The reason why the name is not available, if nameAvailable is false"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The localized reason why the name is not available, if nameAvailable is false"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AlreadyExists"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/1284"
+ },
+ {
+ "$ref": "#/1285"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "checkNameAvailability",
+ "resourceType": "Microsoft.DataMigration/services",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1283"
+ },
+ "input": {
+ "$ref": "#/1282"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "checkNameAvailability",
+ "resourceType": "Microsoft.DataMigration/locations",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1283"
+ },
+ "input": {
+ "$ref": "#/1282"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProjectTask",
+ "properties": {
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "HTTP strong entity tag value. This is ignored if submitted."
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 0,
+ "description": "Custom task properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/60"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource ID."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource name."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Resource type."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancel",
+ "resourceType": "Microsoft.DataMigration/services/projects/tasks",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1289"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "command",
+ "resourceType": "Microsoft.DataMigration/services/projects/tasks",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/106"
+ },
+ "input": {
+ "$ref": "#/106"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "cancel",
+ "resourceType": "Microsoft.DataMigration/services/serviceTasks",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1289"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileStorageInfo",
+ "properties": {
+ "uri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A URI that can be used to access the file content."
+ },
+ "headers": {
+ "type": {
+ "$ref": "#/1294"
+ },
+ "flags": 0,
+ "description": "Dictionary of "
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FileStorageInfoHeaders",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "read",
+ "resourceType": "Microsoft.DataMigration/services/projects/files",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1293"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "readwrite",
+ "resourceType": "Microsoft.DataMigration/services/projects/files",
+ "apiVersion": "2025-03-15-preview",
+ "output": {
+ "$ref": "#/1293"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/dataprotection/microsoft.dataprotection/2023-08-01-preview/types.json b/internal/azure/generated/dataprotection/microsoft.dataprotection/2023-08-01-preview/types.json
index 887f2624c..4c486669f 100644
--- a/internal/azure/generated/dataprotection/microsoft.dataprotection/2023-08-01-preview/types.json
+++ b/internal/azure/generated/dataprotection/microsoft.dataprotection/2023-08-01-preview/types.json
@@ -6260,6 +6260,9 @@
"name": "validateForModifyBackup",
"resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
"apiVersion": "2023-08-01-preview",
+ "output": {
+ "$ref": "#/443"
+ },
"input": {
"$ref": "#/463"
}
diff --git a/internal/azure/generated/dataprotection/microsoft.dataprotection/2024-02-01-preview/types.json b/internal/azure/generated/dataprotection/microsoft.dataprotection/2024-02-01-preview/types.json
index 83227ce37..b12c8e05c 100644
--- a/internal/azure/generated/dataprotection/microsoft.dataprotection/2024-02-01-preview/types.json
+++ b/internal/azure/generated/dataprotection/microsoft.dataprotection/2024-02-01-preview/types.json
@@ -6417,6 +6417,9 @@
"name": "validateForModifyBackup",
"resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
"apiVersion": "2024-02-01-preview",
+ "output": {
+ "$ref": "#/455"
+ },
"input": {
"$ref": "#/475"
}
diff --git a/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-01-01/types.json b/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-01-01/types.json
index 82111b370..ecd63676d 100644
--- a/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-01-01/types.json
+++ b/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-01-01/types.json
@@ -6446,6 +6446,9 @@
"name": "validateForModifyBackup",
"resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
"apiVersion": "2025-01-01",
+ "output": {
+ "$ref": "#/461"
+ },
"input": {
"$ref": "#/481"
}
diff --git a/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-02-01/types.json b/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-02-01/types.json
new file mode 100644
index 000000000..5c1aa7b24
--- /dev/null
+++ b/internal/azure/generated/dataprotection/microsoft.dataprotection/2025-02-01/types.json
@@ -0,0 +1,6917 @@
+[
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 1,
+ "description": "BackupVaultResource properties"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 0,
+ "description": "Input Managed Identity Details"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Optional ETag."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource location."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/92"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupVault",
+ "properties": {
+ "monitoringSettings": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "Monitoring Settings"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/15"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the BackupVault resource"
+ },
+ "resourceMoveState": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 2,
+ "description": "Resource move state for backup vault"
+ },
+ "resourceMoveDetails": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Resource move details for backup vault"
+ },
+ "securitySettings": {
+ "type": {
+ "$ref": "#/28"
+ },
+ "flags": 0,
+ "description": "Security Settings"
+ },
+ "storageSettings": {
+ "type": {
+ "$ref": "#/62"
+ },
+ "flags": 1,
+ "description": "Storage Settings"
+ },
+ "isVaultProtectedByResourceGuard": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 2,
+ "description": "Is vault protected by resource guard"
+ },
+ "featureSettings": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 0,
+ "description": "Feature Settings"
+ },
+ "secureScore": {
+ "type": {
+ "$ref": "#/79"
+ },
+ "flags": 2,
+ "description": "Secure Score of Backup Vault"
+ },
+ "bcdrSecurityLevel": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 2,
+ "description": "Security Level of Backup Vault"
+ },
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ },
+ "replicatedRegions": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "List of replicated regions for Backup Vault"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MonitoringSettings",
+ "properties": {
+ "azureMonitorAlertSettings": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Settings for Azure Monitor based alerts"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureMonitorAlertSettings",
+ "properties": {
+ "alertsForAllJobFailures": {
+ "type": {
+ "$ref": "#/9"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/7"
+ },
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/12"
+ },
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "InProgress"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PrepareFailed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CommitFailed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PrepareTimedout"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CommitTimedout"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CriticalFailure"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PartialSuccess"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MoveSucceeded"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/22"
+ },
+ {
+ "$ref": "#/23"
+ },
+ {
+ "$ref": "#/24"
+ },
+ {
+ "$ref": "#/25"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceMoveDetails",
+ "properties": {
+ "operationId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "CorrelationId of latest ResourceMove operation attempted"
+ },
+ "startTimeUtc": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format."
+ },
+ "completionTimeUtc": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format."
+ },
+ "sourceResourcePath": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "ARM resource path of source resource"
+ },
+ "targetResourcePath": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "ARM resource path of target resource used in latest ResourceMove operation"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecuritySettings",
+ "properties": {
+ "softDeleteSettings": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 0,
+ "description": "Soft delete related settings"
+ },
+ "immutabilitySettings": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 0,
+ "description": "Immutability Settings at vault level"
+ },
+ "encryptionSettings": {
+ "type": {
+ "$ref": "#/40"
+ },
+ "flags": 0,
+ "description": "Customer Managed Key details of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SoftDeleteSettings",
+ "properties": {
+ "state": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "State of soft delete"
+ },
+ "retentionDurationInDays": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 0,
+ "description": "Soft delete retention duration"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Off"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "On"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AlwaysOn"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/30"
+ },
+ {
+ "$ref": "#/31"
+ },
+ {
+ "$ref": "#/32"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImmutabilitySettings",
+ "properties": {
+ "state": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 0,
+ "description": "Immutability state"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unlocked"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Locked"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "EncryptionSettings",
+ "properties": {
+ "state": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 0,
+ "description": "Encryption state of the Backup Vault."
+ },
+ "keyVaultProperties": {
+ "type": {
+ "$ref": "#/45"
+ },
+ "flags": 0,
+ "description": "The properties of the Key Vault which hosts CMK"
+ },
+ "kekIdentity": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "The details of the managed identity used for CMK"
+ },
+ "infrastructureEncryption": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "Enabling/Disabling the Double Encryption state"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Inconsistent"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CmkKeyVaultProperties",
+ "properties": {
+ "keyUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The key uri of the Customer Managed Key"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CmkKekIdentity",
+ "properties": {
+ "identityType": {
+ "type": {
+ "$ref": "#/49"
+ },
+ "flags": 0,
+ "description": "The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity."
+ },
+ "identityId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/51"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "StorageSetting",
+ "properties": {
+ "datastoreType": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 0,
+ "description": "Gets or sets the type of the datastore."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/61"
+ },
+ "flags": 0,
+ "description": "Gets or sets the type."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ArchiveStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OperationalStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VaultStore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/54"
+ },
+ {
+ "$ref": "#/55"
+ },
+ {
+ "$ref": "#/56"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GeoRedundant"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "LocallyRedundant"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ZoneRedundant"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/58"
+ },
+ {
+ "$ref": "#/59"
+ },
+ {
+ "$ref": "#/60"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/53"
+ }
+ },
+ {
+ "$type": "BooleanType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FeatureSettings",
+ "properties": {
+ "crossSubscriptionRestoreSettings": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "CrossSubscriptionRestore Settings"
+ },
+ "crossRegionRestoreSettings": {
+ "type": {
+ "$ref": "#/70"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CrossSubscriptionRestoreSettings",
+ "properties": {
+ "state": {
+ "type": {
+ "$ref": "#/69"
+ },
+ "flags": 0,
+ "description": "CrossSubscriptionRestore state"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PermanentlyDisabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/66"
+ },
+ {
+ "$ref": "#/67"
+ },
+ {
+ "$ref": "#/68"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CrossRegionRestoreSettings",
+ "properties": {
+ "state": {
+ "type": {
+ "$ref": "#/73"
+ },
+ "flags": 0,
+ "description": "CrossRegionRestore state"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Minimum"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Adequate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Maximum"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotSupported"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/74"
+ },
+ {
+ "$ref": "#/75"
+ },
+ {
+ "$ref": "#/76"
+ },
+ {
+ "$ref": "#/77"
+ },
+ {
+ "$ref": "#/78"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Poor"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fair"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Good"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Excellent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotSupported"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/80"
+ },
+ {
+ "$ref": "#/81"
+ },
+ {
+ "$ref": "#/82"
+ },
+ {
+ "$ref": "#/83"
+ },
+ {
+ "$ref": "#/84"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppIdentityDetails",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None"
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/91"
+ },
+ "flags": 0,
+ "description": "Gets or sets the user assigned identities."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 2,
+ "description": "The principal ID of the assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/90"
+ },
+ "flags": 2,
+ "description": "The client ID of the assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppIdentityDetailsUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/89"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppBaseTrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/98"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/103"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/94"
+ },
+ {
+ "$ref": "#/95"
+ },
+ {
+ "$ref": "#/96"
+ },
+ {
+ "$ref": "#/97"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/99"
+ },
+ {
+ "$ref": "#/100"
+ },
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/3"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/backupPolicies"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/105"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/106"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/108"
+ },
+ "flags": 0,
+ "description": "BaseBackupPolicyResource properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BaseBackupPolicy",
+ "discriminator": "objectType",
+ "baseProperties": {
+ "datasourceTypes": {
+ "type": {
+ "$ref": "#/109"
+ },
+ "flags": 1,
+ "description": "Type of datasource for the backup management"
+ }
+ },
+ "elements": {
+ "BackupPolicy": {
+ "$ref": "#/110"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupPolicy",
+ "properties": {
+ "policyRules": {
+ "type": {
+ "$ref": "#/193"
+ },
+ "flags": 1,
+ "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BasePolicyRule",
+ "discriminator": "objectType",
+ "baseProperties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ }
+ },
+ "elements": {
+ "AzureBackupRule": {
+ "$ref": "#/112"
+ },
+ "AzureRetentionRule": {
+ "$ref": "#/177"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupRule",
+ "properties": {
+ "backupParameters": {
+ "type": {
+ "$ref": "#/113"
+ },
+ "flags": 0,
+ "description": "BackupParameters base"
+ },
+ "dataStore": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 1,
+ "description": "DataStoreInfo base"
+ },
+ "trigger": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 1,
+ "description": "Trigger context"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/176"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BackupParameters",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "AzureBackupParams": {
+ "$ref": "#/114"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupParams",
+ "properties": {
+ "backupType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "BackupType ; Full/Incremental etc"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/115"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBackupParams"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DataStoreInfoBase",
+ "properties": {
+ "dataStoreType": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 1,
+ "description": "type of datastore; Operational/Vault/Archive"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Type of Datasource object, used to initialize the right inherited type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OperationalStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VaultStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ArchiveStore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/117"
+ },
+ {
+ "$ref": "#/118"
+ },
+ {
+ "$ref": "#/119"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "TriggerContext",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "AdhocBasedTriggerContext": {
+ "$ref": "#/122"
+ },
+ "ScheduleBasedTriggerContext": {
+ "$ref": "#/126"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdhocBasedTriggerContext",
+ "properties": {
+ "taggingCriteria": {
+ "type": {
+ "$ref": "#/123"
+ },
+ "flags": 1,
+ "description": "Tagging Criteria containing retention tag for adhoc backup."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/125"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdhocBasedTaggingCriteria",
+ "properties": {
+ "tagInfo": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 0,
+ "description": "Retention tag information"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RetentionTag",
+ "properties": {
+ "eTag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Retention Tag version."
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Retention Tag version."
+ },
+ "tagName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Retention Tag Name to relate it to retention rule."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AdhocBasedTriggerContext"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduleBasedTriggerContext",
+ "properties": {
+ "schedule": {
+ "type": {
+ "$ref": "#/127"
+ },
+ "flags": 1,
+ "description": "Schedule for this backup"
+ },
+ "taggingCriteria": {
+ "type": {
+ "$ref": "#/174"
+ },
+ "flags": 1,
+ "description": "List of tags that can be applicable for given schedule."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/175"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupSchedule",
+ "properties": {
+ "repeatingTimeIntervals": {
+ "type": {
+ "$ref": "#/128"
+ },
+ "flags": 1,
+ "description": "ISO 8601 repeating time interval format"
+ },
+ "timeZone": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Time zone for a schedule. Example: Pacific Standard Time"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TaggingCriteria",
+ "properties": {
+ "criteria": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 0,
+ "description": "Criteria which decides whether the tag can be applied to a triggered backup."
+ },
+ "isDefault": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Specifies if tag is default."
+ },
+ "taggingPriority": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 1,
+ "description": "Retention Tag priority."
+ },
+ "tagInfo": {
+ "type": {
+ "$ref": "#/124"
+ },
+ "flags": 1,
+ "description": "Retention tag information"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BackupCriteria",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "ScheduleBasedBackupCriteria": {
+ "$ref": "#/131"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScheduleBasedBackupCriteria",
+ "properties": {
+ "absoluteCriteria": {
+ "type": {
+ "$ref": "#/138"
+ },
+ "flags": 0,
+ "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum"
+ },
+ "daysOfMonth": {
+ "type": {
+ "$ref": "#/140"
+ },
+ "flags": 0,
+ "description": "This is day of the month from 1 to 28 other wise last of month"
+ },
+ "daysOfTheWeek": {
+ "type": {
+ "$ref": "#/149"
+ },
+ "flags": 0,
+ "description": "It should be Sunday/Monday/T..../Saturday"
+ },
+ "monthsOfYear": {
+ "type": {
+ "$ref": "#/163"
+ },
+ "flags": 0,
+ "description": "It should be January/February/....../December"
+ },
+ "scheduleTimes": {
+ "type": {
+ "$ref": "#/164"
+ },
+ "flags": 0,
+ "description": "List of schedule times for backup"
+ },
+ "weeksOfTheMonth": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 0,
+ "description": "It should be First/Second/Third/Fourth/Last"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AllBackup"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FirstOfDay"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FirstOfMonth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FirstOfWeek"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FirstOfYear"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/132"
+ },
+ {
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/134"
+ },
+ {
+ "$ref": "#/135"
+ },
+ {
+ "$ref": "#/136"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/137"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Day",
+ "properties": {
+ "date": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 0,
+ "description": "Date of the month"
+ },
+ "isLast": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "Whether Date is last date of month"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/139"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/141"
+ },
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/144"
+ },
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/147"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/148"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "April"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "August"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "December"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "February"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "January"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "July"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "June"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "March"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "May"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "November"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "October"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "September"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/150"
+ },
+ {
+ "$ref": "#/151"
+ },
+ {
+ "$ref": "#/152"
+ },
+ {
+ "$ref": "#/153"
+ },
+ {
+ "$ref": "#/154"
+ },
+ {
+ "$ref": "#/155"
+ },
+ {
+ "$ref": "#/156"
+ },
+ {
+ "$ref": "#/157"
+ },
+ {
+ "$ref": "#/158"
+ },
+ {
+ "$ref": "#/159"
+ },
+ {
+ "$ref": "#/160"
+ },
+ {
+ "$ref": "#/161"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/162"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "First"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Fourth"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Last"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Second"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Third"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/165"
+ },
+ {
+ "$ref": "#/166"
+ },
+ {
+ "$ref": "#/167"
+ },
+ {
+ "$ref": "#/168"
+ },
+ {
+ "$ref": "#/169"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/170"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ScheduleBasedBackupCriteria"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/130"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/129"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ScheduleBasedTriggerContext"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBackupRule"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureRetentionRule",
+ "properties": {
+ "isDefault": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0
+ },
+ "lifecycles": {
+ "type": {
+ "$ref": "#/191"
+ },
+ "flags": 1
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/192"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SourceLifeCycle",
+ "properties": {
+ "deleteAfter": {
+ "type": {
+ "$ref": "#/179"
+ },
+ "flags": 1,
+ "description": "Delete Option"
+ },
+ "sourceDataStore": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 1,
+ "description": "DataStoreInfo base"
+ },
+ "targetDataStoreCopySettings": {
+ "type": {
+ "$ref": "#/190"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "DeleteOption",
+ "discriminator": "objectType",
+ "baseProperties": {
+ "duration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Duration of deletion after given timespan"
+ }
+ },
+ "elements": {
+ "AbsoluteDeleteOption": {
+ "$ref": "#/180"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AbsoluteDeleteOption",
+ "properties": {
+ "objectType": {
+ "type": {
+ "$ref": "#/181"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AbsoluteDeleteOption"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TargetCopySetting",
+ "properties": {
+ "copyAfter": {
+ "type": {
+ "$ref": "#/183"
+ },
+ "flags": 1,
+ "description": "It can be CustomCopyOption or ImmediateCopyOption."
+ },
+ "dataStore": {
+ "type": {
+ "$ref": "#/116"
+ },
+ "flags": 1,
+ "description": "Info of target datastore"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "CopyOption",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "CopyOnExpiryOption": {
+ "$ref": "#/184"
+ },
+ "CustomCopyOption": {
+ "$ref": "#/186"
+ },
+ "ImmediateCopyOption": {
+ "$ref": "#/188"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CopyOnExpiryOption",
+ "properties": {
+ "objectType": {
+ "type": {
+ "$ref": "#/185"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CopyOnExpiryOption"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CustomCopyOption",
+ "properties": {
+ "duration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Data copied after given timespan"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/187"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CustomCopyOption"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImmediateCopyOption",
+ "properties": {
+ "objectType": {
+ "type": {
+ "$ref": "#/189"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ImmediateCopyOption"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/182"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/178"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureRetentionRule"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/111"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BackupPolicy"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/107"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/backupInstances"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/197"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "BackupInstanceResource properties"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/272"
+ },
+ "flags": 0,
+ "description": "Proxy Resource tags."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BackupInstance",
+ "properties": {
+ "friendlyName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Backup Instance friendly name."
+ },
+ "dataSourceInfo": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 1,
+ "description": "Gets or sets the data source information."
+ },
+ "dataSourceSetInfo": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "Gets or sets the data source set information."
+ },
+ "policyInfo": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 1,
+ "description": "Gets or sets the policy information."
+ },
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/233"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ },
+ "protectionStatus": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 2,
+ "description": "Specifies the protection status of the resource"
+ },
+ "currentProtectionState": {
+ "type": {
+ "$ref": "#/260"
+ },
+ "flags": 2,
+ "description": "Specifies the current protection state of the resource"
+ },
+ "protectionErrorDetails": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 2,
+ "description": "Specifies the protection error of the resource"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed"
+ },
+ "datasourceAuthCredentials": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "validationType": {
+ "type": {
+ "$ref": "#/270"
+ },
+ "flags": 0,
+ "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again."
+ },
+ "identityDetails": {
+ "type": {
+ "$ref": "#/271"
+ },
+ "flags": 0,
+ "description": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Datasource",
+ "properties": {
+ "datasourceType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "DatasourceType of the resource."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Type of Datasource object, used to initialize the right inherited type"
+ },
+ "resourceID": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault."
+ },
+ "resourceLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Location of datasource."
+ },
+ "resourceName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Unique identifier of the resource in the context of parent."
+ },
+ "resourceType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Type of Datasource."
+ },
+ "resourceUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Uri of the resource."
+ },
+ "resourceProperties": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 0,
+ "description": "Properties specific to data source"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BaseResourceProperties",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "DefaultResourceProperties": {
+ "$ref": "#/202"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DefaultResourceProperties",
+ "properties": {
+ "objectType": {
+ "type": {
+ "$ref": "#/203"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DefaultResourceProperties"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DatasourceSet",
+ "properties": {
+ "datasourceType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "DatasourceType of the resource."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Type of Datasource object, used to initialize the right inherited type"
+ },
+ "resourceID": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault."
+ },
+ "resourceLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Location of datasource."
+ },
+ "resourceName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Unique identifier of the resource in the context of parent."
+ },
+ "resourceType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource Type of Datasource."
+ },
+ "resourceUri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Uri of the resource."
+ },
+ "resourceProperties": {
+ "type": {
+ "$ref": "#/201"
+ },
+ "flags": 0,
+ "description": "Properties specific to data source set"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PolicyInfo",
+ "properties": {
+ "policyId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "policyVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2
+ },
+ "policyParameters": {
+ "type": {
+ "$ref": "#/206"
+ },
+ "flags": 0,
+ "description": "Policy parameters for the backup instance"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PolicyParameters",
+ "properties": {
+ "dataStoreParametersList": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "Gets or sets the DataStore Parameters"
+ },
+ "backupDatasourceParametersList": {
+ "type": {
+ "$ref": "#/232"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Backup Data Source Parameters"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "DataStoreParameters",
+ "discriminator": "objectType",
+ "baseProperties": {
+ "dataStoreType": {
+ "type": {
+ "$ref": "#/211"
+ },
+ "flags": 1,
+ "description": "type of datastore; Operational/Vault/Archive"
+ }
+ },
+ "elements": {
+ "AzureOperationalStoreParameters": {
+ "$ref": "#/212"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OperationalStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VaultStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ArchiveStore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/208"
+ },
+ {
+ "$ref": "#/209"
+ },
+ {
+ "$ref": "#/210"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureOperationalStoreParameters",
+ "properties": {
+ "resourceGroupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Snapshot Resource Group Uri."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/213"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureOperationalStoreParameters"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/207"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "BackupDatasourceParameters",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "AdlsBlobBackupDatasourceParameters": {
+ "$ref": "#/216"
+ },
+ "KubernetesClusterBackupDatasourceParameters": {
+ "$ref": "#/219"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdlsBlobBackupDatasourceParameters",
+ "properties": {
+ "containersList": {
+ "type": {
+ "$ref": "#/217"
+ },
+ "flags": 1,
+ "description": "List of containers to be backed up during configuration of backup of blobs"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/218"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AdlsBlobBackupDatasourceParameters"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesClusterBackupDatasourceParameters",
+ "properties": {
+ "snapshotVolumes": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup."
+ },
+ "includedVolumeTypes": {
+ "type": {
+ "$ref": "#/223"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include volume types property. This property sets the volume types to be included during backup."
+ },
+ "includeClusterScopeResources": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup."
+ },
+ "includedNamespaces": {
+ "type": {
+ "$ref": "#/224"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during backup."
+ },
+ "excludedNamespaces": {
+ "type": {
+ "$ref": "#/225"
+ },
+ "flags": 0,
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup."
+ },
+ "includedResourceTypes": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during backup."
+ },
+ "excludedResourceTypes": {
+ "type": {
+ "$ref": "#/227"
+ },
+ "flags": 0,
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup."
+ },
+ "labelSelectors": {
+ "type": {
+ "$ref": "#/228"
+ },
+ "flags": 0,
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup."
+ },
+ "backupHookReferences": {
+ "type": {
+ "$ref": "#/230"
+ },
+ "flags": 0,
+ "description": "Gets or sets the backup hook references. This property sets the hook reference to be executed during backup."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/231"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureDisk"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureFileShareSMB"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/220"
+ },
+ {
+ "$ref": "#/221"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/222"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NamespacedNameResource",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of the resource"
+ },
+ "namespace": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Namespace in which the resource exists"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/229"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesClusterBackupDatasourceParameters"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/215"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ProtectionStatusDetails",
+ "properties": {
+ "errorDetails": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 0,
+ "description": "Specifies the protection status error of the resource"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/247"
+ },
+ "flags": 0,
+ "description": "Specifies the protection status of the resource"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserFacingError",
+ "properties": {
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Unique code for this error"
+ },
+ "details": {
+ "type": {
+ "$ref": "#/236"
+ },
+ "flags": 0,
+ "description": "Additional related Errors"
+ },
+ "innerError": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "Inner Error"
+ },
+ "isRetryable": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "Whether the operation will be retryable or not"
+ },
+ "isUserError": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "Whether the operation is due to a user error or service error"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/239"
+ },
+ "flags": 0,
+ "description": "Any key value pairs that can be injected inside error object"
+ },
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "recommendedAction": {
+ "type": {
+ "$ref": "#/240"
+ },
+ "flags": 0,
+ "description": "RecommendedAction � localized."
+ },
+ "target": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Target of the error."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/235"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InnerError",
+ "properties": {
+ "additionalInfo": {
+ "type": {
+ "$ref": "#/238"
+ },
+ "flags": 0,
+ "description": "Any Key value pairs that can be provided to the client for additional verbose information."
+ },
+ "code": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Unique code for this error"
+ },
+ "embeddedInnerError": {
+ "type": {
+ "$ref": "#/237"
+ },
+ "flags": 0,
+ "description": "Child Inner Error, to allow Nesting."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "InnerErrorAdditionalInfo",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserFacingErrorProperties",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfiguringProtection"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfiguringProtectionFailed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionConfigured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionStopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SoftDeleted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SoftDeleting"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/241"
+ },
+ {
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/243"
+ },
+ {
+ "$ref": "#/244"
+ },
+ {
+ "$ref": "#/245"
+ },
+ {
+ "$ref": "#/246"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotProtected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfiguringProtection"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionConfigured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BackupSchedulesSuspended"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RetentionSchedulesSuspended"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionStopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionError"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfiguringProtectionFailed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SoftDeleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SoftDeleted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UpdatingProtection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/248"
+ },
+ {
+ "$ref": "#/249"
+ },
+ {
+ "$ref": "#/250"
+ },
+ {
+ "$ref": "#/251"
+ },
+ {
+ "$ref": "#/252"
+ },
+ {
+ "$ref": "#/253"
+ },
+ {
+ "$ref": "#/254"
+ },
+ {
+ "$ref": "#/255"
+ },
+ {
+ "$ref": "#/256"
+ },
+ {
+ "$ref": "#/257"
+ },
+ {
+ "$ref": "#/258"
+ },
+ {
+ "$ref": "#/259"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "AuthCredentials",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "SecretStoreBasedAuthCredentials": {
+ "$ref": "#/262"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecretStoreBasedAuthCredentials",
+ "properties": {
+ "secretStoreResource": {
+ "type": {
+ "$ref": "#/263"
+ },
+ "flags": 0,
+ "description": "Secret store resource"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecretStoreResource",
+ "properties": {
+ "uri": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Uri to get to the resource"
+ },
+ "secretStoreType": {
+ "type": {
+ "$ref": "#/266"
+ },
+ "flags": 1,
+ "description": "Gets or sets the type of secret store"
+ },
+ "value": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets value stored in secret store resource"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureKeyVault"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/264"
+ },
+ {
+ "$ref": "#/265"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SecretStoreBasedAuthCredentials"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ShallowValidation"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DeepValidation"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/268"
+ },
+ {
+ "$ref": "#/269"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "IdentityDetails",
+ "properties": {
+ "useSystemAssignedIdentity": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "Specifies if the BI is protected by System Identity."
+ },
+ "userAssignedIdentityArmUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "ARM URL for User Assigned Identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppProxyResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/198"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/resourceGuards"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/274"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/275"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/277"
+ },
+ "flags": 0,
+ "description": "ResourceGuardResource properties"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Optional ETag."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource location."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/287"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceGuard",
+ "properties": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/283"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the BackupVault resource"
+ },
+ "allowAutoApprovals": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 2,
+ "description": "This flag indicates whether auto approval is allowed or not."
+ },
+ "resourceGuardOperations": {
+ "type": {
+ "$ref": "#/285"
+ },
+ "flags": 2,
+ "description": "{readonly} List of operation details those are protected by the ResourceGuard resource"
+ },
+ "vaultCriticalOperationExclusionList": {
+ "type": {
+ "$ref": "#/286"
+ },
+ "flags": 0,
+ "description": "List of critical operations which are not protected by this resourceGuard"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Description about the pre-req steps to perform all the critical operations."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unknown"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/278"
+ },
+ {
+ "$ref": "#/279"
+ },
+ {
+ "$ref": "#/280"
+ },
+ {
+ "$ref": "#/281"
+ },
+ {
+ "$ref": "#/282"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceGuardOperation",
+ "properties": {
+ "vaultCriticalOperation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Name of the critical operation."
+ },
+ "requestResourceType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Type of resource request."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/284"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppBaseTrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/resourceGuards@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/276"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[A-Za-z0-9]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/289"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/290"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/291"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/293"
+ },
+ "flags": 0,
+ "description": "ResourceGuardProxyBaseResource properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceGuardProxyBase",
+ "properties": {
+ "resourceGuardResourceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "resourceGuardOperationDetails": {
+ "type": {
+ "$ref": "#/295"
+ },
+ "flags": 0
+ },
+ "lastUpdatedTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "description": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ResourceGuardOperationDetail",
+ "properties": {
+ "vaultCriticalOperation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "defaultResourceRequest": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/294"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/292"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/operationResults"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/operationResults",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/297"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/298"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/4"
+ },
+ "flags": 2,
+ "description": "BackupVaultResource properties"
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 2,
+ "description": "Input Managed Identity Details"
+ },
+ "eTag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Optional ETag."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource location."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 2,
+ "description": "Resource tags."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppBaseTrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/operationResults@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/299"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/302"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/303"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 2,
+ "description": "BackupInstanceResource properties"
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/305"
+ },
+ "flags": 2,
+ "description": "Proxy Resource tags."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DppProxyResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/304"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/307"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/308"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 2,
+ "description": "AzureBackupRecoveryPointResource properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "AzureBackupRecoveryPoint",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "AzureBackupDiscreteRecoveryPoint": {
+ "$ref": "#/311"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupDiscreteRecoveryPoint",
+ "properties": {
+ "friendlyName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "recoveryPointDataStoresDetails": {
+ "type": {
+ "$ref": "#/319"
+ },
+ "flags": 0
+ },
+ "recoveryPointTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "policyName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "policyVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "recoveryPointId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "recoveryPointType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "retentionTagName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "retentionTagVersion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "expiryTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2
+ },
+ "recoveryPointState": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 0,
+ "description": "Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up)."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RecoveryPointDataStoreDetails",
+ "properties": {
+ "creationTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "expiryTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "metaData": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "state": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "visible": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0
+ },
+ "rehydrationExpiryTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2
+ },
+ "rehydrationStatus": {
+ "type": {
+ "$ref": "#/318"
+ },
+ "flags": 2
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CREATE_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "COMPLETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DELETE_IN_PROGRESS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DELETED"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FAILED"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/313"
+ },
+ {
+ "$ref": "#/314"
+ },
+ {
+ "$ref": "#/315"
+ },
+ {
+ "$ref": "#/316"
+ },
+ {
+ "$ref": "#/317"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/312"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Completed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Partial"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/320"
+ },
+ {
+ "$ref": "#/321"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBackupDiscreteRecoveryPoint"
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/309"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/backupJobs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/backupJobs",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 2,
+ "description": "AzureBackupJobResource properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupJob",
+ "properties": {
+ "activityID": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Job Activity Id"
+ },
+ "backupInstanceFriendlyName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Backup Instance"
+ },
+ "backupInstanceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "ARM ID of the Backup Instance"
+ },
+ "dataSourceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "ARM ID of the DataSource"
+ },
+ "dataSourceLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Location of the DataSource"
+ },
+ "dataSourceName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "User Friendly Name of the DataSource"
+ },
+ "dataSourceSetName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Data Source Set Name of the DataSource"
+ },
+ "dataSourceType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Type of DataSource"
+ },
+ "duration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Total run time of the job. ISO 8601 format."
+ },
+ "endTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "EndTime of the job(in UTC)"
+ },
+ "errorDetails": {
+ "type": {
+ "$ref": "#/329"
+ },
+ "flags": 2,
+ "description": "A List, detailing the errors related to the job"
+ },
+ "extendedInfo": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 2,
+ "description": "Extended Information about the job"
+ },
+ "isUserTriggered": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Indicated that whether the job is adhoc(true) or scheduled(false)"
+ },
+ "operation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure"
+ },
+ "operationCategory": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management"
+ },
+ "policyId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "ARM ID of the policy"
+ },
+ "policyName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Name of the policy"
+ },
+ "progressEnabled": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Indicated whether progress is enabled for the job"
+ },
+ "progressUrl": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Url which contains job's progress"
+ },
+ "rehydrationPriority": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Priority to be used for rehydration"
+ },
+ "restoreType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR"
+ },
+ "sourceResourceGroup": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Resource Group Name of the Datasource"
+ },
+ "sourceSubscriptionID": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "SubscriptionId corresponding to the DataSource"
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "StartTime of the job(in UTC)"
+ },
+ "status": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused"
+ },
+ "subscriptionId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Subscription Id of the corresponding backup vault"
+ },
+ "supportedActions": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 1,
+ "description": "List of supported actions"
+ },
+ "vaultName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the vault"
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "sourceDataStoreName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "destinationDataStoreName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/235"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "JobExtendedInfo",
+ "properties": {
+ "additionalDetails": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 0,
+ "description": "Job's Additional Details"
+ },
+ "backupInstanceState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "State of the Backup Instance"
+ },
+ "dataTransferredInBytes": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 2,
+ "description": "Number of bytes transferred"
+ },
+ "recoveryDestination": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Destination where restore is done"
+ },
+ "sourceRecoverPoint": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 2,
+ "description": "Details of the Source Recovery Point"
+ },
+ "subTasks": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 2,
+ "description": "List of Sub Tasks of the job"
+ },
+ "targetRecoverPoint": {
+ "type": {
+ "$ref": "#/332"
+ },
+ "flags": 2,
+ "description": "Details of the Target Recovery Point"
+ },
+ "warningDetails": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 2,
+ "description": "A List, detailing the warnings related to the job"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "JobExtendedInfoAdditionalDetails",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestoreJobRecoveryPointDetails",
+ "properties": {
+ "recoveryPointID": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ },
+ "recoveryPointTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "JobSubTask",
+ "properties": {
+ "additionalDetails": {
+ "type": {
+ "$ref": "#/334"
+ },
+ "flags": 0,
+ "description": "Additional details of Sub Tasks"
+ },
+ "taskId": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 1,
+ "description": "Task Id of the Sub Task"
+ },
+ "taskName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Name of the Sub Task"
+ },
+ "taskProgress": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Progress of the Sub Task"
+ },
+ "taskStatus": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Status of the Sub Task"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "JobSubTaskAdditionalDetails",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/333"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserFacingWarningDetail",
+ "properties": {
+ "resourceName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name of resource for which warning is raised."
+ },
+ "warning": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 1,
+ "description": "Error details for the warning."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/336"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/backupJobs@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/327"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DataProtection/backupVaults/deletedBackupInstances"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/340"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/341"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/343"
+ },
+ "flags": 2,
+ "description": "DeletedBackupInstanceResource properties"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DeletedBackupInstance",
+ "properties": {
+ "deletionInfo": {
+ "type": {
+ "$ref": "#/344"
+ },
+ "flags": 2,
+ "description": "Deletion info of Backup Instance"
+ },
+ "friendlyName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Backup Instance friendly name."
+ },
+ "dataSourceInfo": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 1,
+ "description": "Gets or sets the data source information."
+ },
+ "dataSourceSetInfo": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "Gets or sets the data source set information."
+ },
+ "policyInfo": {
+ "type": {
+ "$ref": "#/205"
+ },
+ "flags": 1,
+ "description": "Gets or sets the policy information."
+ },
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/345"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ },
+ "protectionStatus": {
+ "type": {
+ "$ref": "#/234"
+ },
+ "flags": 2,
+ "description": "Specifies the protection status of the resource"
+ },
+ "currentProtectionState": {
+ "type": {
+ "$ref": "#/358"
+ },
+ "flags": 2,
+ "description": "Specifies the current protection state of the resource"
+ },
+ "protectionErrorDetails": {
+ "type": {
+ "$ref": "#/235"
+ },
+ "flags": 2,
+ "description": "Specifies the protection error of the resource"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed"
+ },
+ "datasourceAuthCredentials": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "validationType": {
+ "type": {
+ "$ref": "#/361"
+ },
+ "flags": 0,
+ "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again."
+ },
+ "identityDetails": {
+ "type": {
+ "$ref": "#/271"
+ },
+ "flags": 0,
+ "description": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DeletionInfo",
+ "properties": {
+ "deletionTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies time of deletion"
+ },
+ "billingEndDate": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies billing end date"
+ },
+ "scheduledPurgeTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Specifies purge time"
+ },
+ "deleteActivityID": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Delete activity ID for troubleshooting purpose"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotProtected"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfiguringProtection"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionConfigured"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BackupSchedulesSuspended"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RetentionSchedulesSuspended"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionStopped"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ProtectionError"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfiguringProtectionFailed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SoftDeleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SoftDeleted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UpdatingProtection"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/347"
+ },
+ {
+ "$ref": "#/348"
+ },
+ {
+ "$ref": "#/349"
+ },
+ {
+ "$ref": "#/350"
+ },
+ {
+ "$ref": "#/351"
+ },
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/353"
+ },
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/355"
+ },
+ {
+ "$ref": "#/356"
+ },
+ {
+ "$ref": "#/357"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ShallowValidation"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DeepValidation"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/359"
+ },
+ {
+ "$ref": "#/360"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DataProtection/backupVaults/deletedBackupInstances@2025-02-01",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/342"
+ },
+ "flags": 1
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CheckNameAvailabilityRequest",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Resource name for which availability needs to be checked"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CheckNameAvailabilityResult",
+ "properties": {
+ "message": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the message."
+ },
+ "nameAvailable": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 0,
+ "description": "Gets or sets a value indicating whether [name available]."
+ },
+ "reason": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the reason."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "checkNameAvailability",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/364"
+ },
+ "input": {
+ "$ref": "#/363"
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "FeatureValidationRequestBase",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "FeatureValidationRequest": {
+ "$ref": "#/367"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FeatureValidationRequest",
+ "properties": {
+ "featureType": {
+ "type": {
+ "$ref": "#/370"
+ },
+ "flags": 0,
+ "description": "backup support feature type."
+ },
+ "featureName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "backup support feature name."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/371"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DataSourceType"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/368"
+ },
+ {
+ "$ref": "#/369"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FeatureValidationRequest"
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "FeatureValidationResponseBase",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "FeatureValidationResponse": {
+ "$ref": "#/373"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FeatureValidationResponse",
+ "properties": {
+ "featureType": {
+ "type": {
+ "$ref": "#/376"
+ },
+ "flags": 0,
+ "description": "backup support feature type."
+ },
+ "features": {
+ "type": {
+ "$ref": "#/386"
+ },
+ "flags": 0,
+ "description": "Response features"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/387"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DataSourceType"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/374"
+ },
+ {
+ "$ref": "#/375"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SupportedFeature",
+ "properties": {
+ "featureName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "support feature type."
+ },
+ "supportStatus": {
+ "type": {
+ "$ref": "#/384"
+ },
+ "flags": 0,
+ "description": "feature support status"
+ },
+ "exposureControlledFeatures": {
+ "type": {
+ "$ref": "#/385"
+ },
+ "flags": 0,
+ "description": "support feature type."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotSupported"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AlphaPreview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PrivatePreview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PublicPreview"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "GenerallyAvailable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/378"
+ },
+ {
+ "$ref": "#/379"
+ },
+ {
+ "$ref": "#/380"
+ },
+ {
+ "$ref": "#/381"
+ },
+ {
+ "$ref": "#/382"
+ },
+ {
+ "$ref": "#/383"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/377"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FeatureValidationResponse"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "checkFeatureSupport",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/372"
+ },
+ "input": {
+ "$ref": "#/366"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CrossRegionRestoreRequestObject",
+ "properties": {
+ "restoreRequestObject": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 1,
+ "description": "Gets or sets the restore request object."
+ },
+ "crossRegionRestoreDetails": {
+ "type": {
+ "$ref": "#/460"
+ },
+ "flags": 1,
+ "description": "Cross region restore details."
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "AzureBackupRestoreRequest",
+ "discriminator": "objectType",
+ "baseProperties": {
+ "restoreTargetInfo": {
+ "type": {
+ "$ref": "#/391"
+ },
+ "flags": 1,
+ "description": "Gets or sets the restore target information."
+ },
+ "sourceDataStoreType": {
+ "type": {
+ "$ref": "#/450"
+ },
+ "flags": 1,
+ "description": "Gets or sets the type of the source data store."
+ },
+ "sourceResourceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered."
+ },
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/451"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ },
+ "identityDetails": {
+ "type": {
+ "$ref": "#/271"
+ },
+ "flags": 0,
+ "description": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned."
+ }
+ },
+ "elements": {
+ "AzureBackupRestoreWithRehydrationRequest": {
+ "$ref": "#/452"
+ },
+ "AzureBackupRecoveryTimeBasedRestoreRequest": {
+ "$ref": "#/458"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "RestoreTargetInfoBase",
+ "discriminator": "objectType",
+ "baseProperties": {
+ "recoveryOption": {
+ "type": {
+ "$ref": "#/393"
+ },
+ "flags": 1,
+ "description": "Recovery Option"
+ },
+ "restoreLocation": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Target Restore region"
+ }
+ },
+ "elements": {
+ "ItemLevelRestoreTargetInfo": {
+ "$ref": "#/394"
+ },
+ "RestoreFilesTargetInfo": {
+ "$ref": "#/437"
+ },
+ "RestoreTargetInfo": {
+ "$ref": "#/444"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "FailIfExists"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/392"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ItemLevelRestoreTargetInfo",
+ "properties": {
+ "restoreCriteria": {
+ "type": {
+ "$ref": "#/435"
+ },
+ "flags": 1,
+ "description": "Restore Criteria"
+ },
+ "datasourceInfo": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 1,
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 1,
+ "description": "Type of Datasource object, used to initialize the right inherited type"
+ }
+ }
+ },
+ {
+ "$type": "DiscriminatedObjectType",
+ "name": "ItemLevelRestoreCriteria",
+ "discriminator": "objectType",
+ "baseProperties": {},
+ "elements": {
+ "ItemPathBasedRestoreCriteria": {
+ "$ref": "#/396"
+ },
+ "KubernetesClusterRestoreCriteria": {
+ "$ref": "#/399"
+ },
+ "KubernetesClusterVaultTierRestoreCriteria": {
+ "$ref": "#/414"
+ },
+ "KubernetesPVRestoreCriteria": {
+ "$ref": "#/429"
+ },
+ "KubernetesStorageClassRestoreCriteria": {
+ "$ref": "#/431"
+ },
+ "RangeBasedItemLevelRestoreCriteria": {
+ "$ref": "#/433"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ItemPathBasedRestoreCriteria",
+ "properties": {
+ "itemPath": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The path of the item to be restored. It could be the full path of the item or the path relative to the backup item"
+ },
+ "isPathRelativeToBackupItem": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Flag to specify if the path is relative to backup item or full path"
+ },
+ "subItemPathPrefix": {
+ "type": {
+ "$ref": "#/397"
+ },
+ "flags": 0,
+ "description": "The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/398"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ItemPathBasedRestoreCriteria"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesClusterRestoreCriteria",
+ "properties": {
+ "includeClusterScopeResources": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore."
+ },
+ "includedNamespaces": {
+ "type": {
+ "$ref": "#/400"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore."
+ },
+ "excludedNamespaces": {
+ "type": {
+ "$ref": "#/401"
+ },
+ "flags": 0,
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore."
+ },
+ "includedResourceTypes": {
+ "type": {
+ "$ref": "#/402"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore."
+ },
+ "excludedResourceTypes": {
+ "type": {
+ "$ref": "#/403"
+ },
+ "flags": 0,
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore."
+ },
+ "labelSelectors": {
+ "type": {
+ "$ref": "#/404"
+ },
+ "flags": 0,
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore."
+ },
+ "persistentVolumeRestoreMode": {
+ "type": {
+ "$ref": "#/407"
+ },
+ "flags": 0,
+ "description": "Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored."
+ },
+ "conflictPolicy": {
+ "type": {
+ "$ref": "#/410"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore."
+ },
+ "namespaceMappings": {
+ "type": {
+ "$ref": "#/411"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore."
+ },
+ "restoreHookReferences": {
+ "type": {
+ "$ref": "#/412"
+ },
+ "flags": 0,
+ "description": "Gets or sets the restore hook references. This property sets the hook reference to be executed during restore."
+ },
+ "resourceModifierReference": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/413"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RestoreWithVolumeData"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RestoreWithoutVolumeData"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/405"
+ },
+ {
+ "$ref": "#/406"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skip"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Patch"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/408"
+ },
+ {
+ "$ref": "#/409"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesClusterRestoreCriteriaNamespaceMappings",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/229"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesClusterRestoreCriteria"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesClusterVaultTierRestoreCriteria",
+ "properties": {
+ "includeClusterScopeResources": {
+ "type": {
+ "$ref": "#/63"
+ },
+ "flags": 1,
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore from vault."
+ },
+ "includedNamespaces": {
+ "type": {
+ "$ref": "#/415"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore from vault."
+ },
+ "excludedNamespaces": {
+ "type": {
+ "$ref": "#/416"
+ },
+ "flags": 0,
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore from vault."
+ },
+ "includedResourceTypes": {
+ "type": {
+ "$ref": "#/417"
+ },
+ "flags": 0,
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore from vault."
+ },
+ "excludedResourceTypes": {
+ "type": {
+ "$ref": "#/418"
+ },
+ "flags": 0,
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore from vault."
+ },
+ "labelSelectors": {
+ "type": {
+ "$ref": "#/419"
+ },
+ "flags": 0,
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore from vault."
+ },
+ "persistentVolumeRestoreMode": {
+ "type": {
+ "$ref": "#/422"
+ },
+ "flags": 0,
+ "description": "Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored from vault."
+ },
+ "conflictPolicy": {
+ "type": {
+ "$ref": "#/425"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore from vault."
+ },
+ "namespaceMappings": {
+ "type": {
+ "$ref": "#/426"
+ },
+ "flags": 0,
+ "description": "Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore from vault."
+ },
+ "restoreHookReferences": {
+ "type": {
+ "$ref": "#/427"
+ },
+ "flags": 0,
+ "description": "Gets or sets the restore hook references. This property sets the hook reference to be executed during restore from vault."
+ },
+ "stagingResourceGroupId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the staging RG Id for creating staging disks and snapshots during restore from vault."
+ },
+ "stagingStorageAccountId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Gets or sets the staging Storage Account Id for creating backup extension object store data during restore from vault."
+ },
+ "resourceModifierReference": {
+ "type": {
+ "$ref": "#/229"
+ },
+ "flags": 0,
+ "description": "Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/428"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RestoreWithVolumeData"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RestoreWithoutVolumeData"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/420"
+ },
+ {
+ "$ref": "#/421"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Skip"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Patch"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/423"
+ },
+ {
+ "$ref": "#/424"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesClusterVaultTierRestoreCriteriaNamespaceMappings",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/229"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesClusterVaultTierRestoreCriteria"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesPVRestoreCriteria",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Selected persistent volume claim name"
+ },
+ "storageClassName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Selected storage class name for restore operation"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/430"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesPVRestoreCriteria"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KubernetesStorageClassRestoreCriteria",
+ "properties": {
+ "selectedStorageClassName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Selected storage class name"
+ },
+ "provisioner": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Provisioner of the storage class"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/432"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "KubernetesStorageClassRestoreCriteria"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RangeBasedItemLevelRestoreCriteria",
+ "properties": {
+ "minMatchingValue": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "minimum value for range prefix match"
+ },
+ "maxMatchingValue": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "maximum value for range prefix match"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/434"
+ },
+ "flags": 1,
+ "description": "Type of the specific object - used for deserializing"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RangeBasedItemLevelRestoreCriteria"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/395"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ItemLevelRestoreTargetInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestoreFilesTargetInfo",
+ "properties": {
+ "targetDetails": {
+ "type": {
+ "$ref": "#/438"
+ },
+ "flags": 1,
+ "description": "Destination of RestoreAsFiles operation, when destination is not a datasource"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/443"
+ },
+ "flags": 1,
+ "description": "Type of Datasource object, used to initialize the right inherited type"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TargetDetails",
+ "properties": {
+ "filePrefix": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them"
+ },
+ "restoreTargetLocationType": {
+ "type": {
+ "$ref": "#/442"
+ },
+ "flags": 1,
+ "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}"
+ },
+ "url": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Url denoting the restore destination. It can point to container / file share etc"
+ },
+ "targetResourceArmId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share\r\nThis is optional if the target subscription can be identified with the URL field. If not\r\nthen this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBlobs"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureFiles"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/439"
+ },
+ {
+ "$ref": "#/440"
+ },
+ {
+ "$ref": "#/441"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RestoreFilesTargetInfo"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestoreTargetInfo",
+ "properties": {
+ "datasourceInfo": {
+ "type": {
+ "$ref": "#/200"
+ },
+ "flags": 1,
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "type": {
+ "$ref": "#/204"
+ },
+ "flags": 0,
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "type": {
+ "$ref": "#/261"
+ },
+ "flags": 0,
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/445"
+ },
+ "flags": 1,
+ "description": "Type of Datasource object, used to initialize the right inherited type"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RestoreTargetInfo"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ArchiveStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SnapshotStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OperationalStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VaultStore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/446"
+ },
+ {
+ "$ref": "#/447"
+ },
+ {
+ "$ref": "#/448"
+ },
+ {
+ "$ref": "#/449"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupRestoreWithRehydrationRequest",
+ "properties": {
+ "rehydrationPriority": {
+ "type": {
+ "$ref": "#/456"
+ },
+ "flags": 1,
+ "description": "Priority to be used for rehydration. Values High or Standard"
+ },
+ "rehydrationRetentionDuration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Retention duration in ISO 8601 format i.e P10D ."
+ },
+ "recoveryPointId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/457"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "High"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/453"
+ },
+ {
+ "$ref": "#/454"
+ },
+ {
+ "$ref": "#/455"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBackupRestoreWithRehydrationRequest"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupRecoveryTimeBasedRestoreRequest",
+ "properties": {
+ "recoveryPointTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/459"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureBackupRecoveryTimeBasedRestoreRequest"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CrossRegionRestoreDetails",
+ "properties": {
+ "sourceRegion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "sourceBackupInstanceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "OperationJobExtendedInfo",
+ "properties": {
+ "jobId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Name or Arm Id of the job created for this operation."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "crossRegionRestore",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/389"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateCrossRegionRestoreRequestObject",
+ "properties": {
+ "restoreRequestObject": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 1,
+ "description": "Gets or sets the restore request object."
+ },
+ "crossRegionRestoreDetails": {
+ "type": {
+ "$ref": "#/460"
+ },
+ "flags": 1,
+ "description": "Cross region restore details."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "validateCrossRegionRestore",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/463"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "FetchSecondaryRPsRequestParameters",
+ "properties": {
+ "sourceRegion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Source region in which BackupInstance is located"
+ },
+ "sourceBackupInstanceId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "ARM Path of BackupInstance"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupRecoveryPointResourceList",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/468"
+ },
+ "flags": 0,
+ "description": "List of resources."
+ },
+ "nextLink": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupRecoveryPointResource",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/310"
+ },
+ "flags": 0,
+ "description": "AzureBackupRecoveryPointResource properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id represents the complete path to the resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource name associated with the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/..."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/467"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "fetchSecondaryRecoveryPoints",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/466"
+ },
+ "input": {
+ "$ref": "#/465"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CrossRegionRestoreJobRequest",
+ "properties": {
+ "sourceRegion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "sourceBackupVaultId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "jobId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupJobResource",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/328"
+ },
+ "flags": 0,
+ "description": "AzureBackupJobResource properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id represents the complete path to the resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource name associated with the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/..."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "fetchCrossRegionRestoreJob",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/471"
+ },
+ "input": {
+ "$ref": "#/470"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CrossRegionRestoreJobsRequest",
+ "properties": {
+ "sourceRegion": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "sourceBackupVaultId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupJobResourceList",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/475"
+ },
+ "flags": 0,
+ "description": "List of resources."
+ },
+ "nextLink": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/471"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "fetchCrossRegionRestoreJobs",
+ "resourceType": "Microsoft.DataProtection/locations",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/474"
+ },
+ "input": {
+ "$ref": "#/473"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TriggerBackupRequest",
+ "properties": {
+ "backupRuleOptions": {
+ "type": {
+ "$ref": "#/478"
+ },
+ "flags": 1,
+ "description": "Name for the Rule of the Policy which needs to be applied for this backup"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdHocBackupRuleOptions",
+ "properties": {
+ "ruleName": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1
+ },
+ "triggerOption": {
+ "type": {
+ "$ref": "#/479"
+ },
+ "flags": 1,
+ "description": "Adhoc backup trigger option"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AdhocBackupTriggerOption",
+ "properties": {
+ "retentionTagOverride": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "backup",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/477"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateForModifyBackupRequest",
+ "properties": {
+ "backupInstance": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 1,
+ "description": "Backup Instance"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "validateForModifyBackup",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/481"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupRehydrationRequest",
+ "properties": {
+ "recoveryPointId": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Id of the recovery point to be recovered"
+ },
+ "rehydrationPriority": {
+ "type": {
+ "$ref": "#/487"
+ },
+ "flags": 0,
+ "description": "Priority to be used for rehydration. Values High or Standard"
+ },
+ "rehydrationRetentionDuration": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Retention duration in ISO 8601 format i.e P10D ."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Invalid"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "High"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/484"
+ },
+ {
+ "$ref": "#/485"
+ },
+ {
+ "$ref": "#/486"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "rehydrate",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/483"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "restore",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/390"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resumeBackups",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "resumeProtection",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "StopProtectionRequest",
+ "properties": {
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/493"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "stopProtection",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/492"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SuspendBackupRequest",
+ "properties": {
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/496"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "suspendBackups",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/495"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SyncBackupInstanceRequest",
+ "properties": {
+ "syncType": {
+ "type": {
+ "$ref": "#/501"
+ },
+ "flags": 0,
+ "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ForceResync"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/499"
+ },
+ {
+ "$ref": "#/500"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "sync",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "input": {
+ "$ref": "#/498"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateRestoreRequestObject",
+ "properties": {
+ "restoreRequestObject": {
+ "type": {
+ "$ref": "#/390"
+ },
+ "flags": 1,
+ "description": "Gets or sets the restore request object."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "validateRestore",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/503"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupFindRestorableTimeRangesRequest",
+ "properties": {
+ "sourceDataStoreType": {
+ "type": {
+ "$ref": "#/509"
+ },
+ "flags": 1,
+ "description": "Gets or sets the type of the source data store."
+ },
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "Start time for the List Restore Ranges request. ISO 8601 format."
+ },
+ "endTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "End time for the List Restore Ranges request. ISO 8601 format."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "OperationalStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "VaultStore"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ArchiveStore"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/506"
+ },
+ {
+ "$ref": "#/507"
+ },
+ {
+ "$ref": "#/508"
+ },
+ {
+ "$ref": "#/0"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupFindRestorableTimeRangesResponseResource",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/511"
+ },
+ "flags": 0,
+ "description": "AzureBackupFindRestorableTimeRangesResponseResource properties"
+ },
+ "id": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource Id represents the complete path to the resource."
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource name associated with the resource."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 2,
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/..."
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/93"
+ },
+ "flags": 2,
+ "description": "Metadata pertaining to creation and last modification of the resource."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureBackupFindRestorableTimeRangesResponse",
+ "properties": {
+ "restorableTimeRanges": {
+ "type": {
+ "$ref": "#/513"
+ },
+ "flags": 0,
+ "description": "Returns the Restore Ranges available on the Backup Instance."
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "RestorableTimeRange",
+ "properties": {
+ "startTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "Start time for the available restore range"
+ },
+ "endTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 1,
+ "description": "End time for the available restore range"
+ },
+ "objectType": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/512"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "findRestorableTimeRanges",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/510"
+ },
+ "input": {
+ "$ref": "#/505"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ValidateForBackupRequest",
+ "properties": {
+ "backupInstance": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 1,
+ "description": "Backup Instance"
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "validateForBackup",
+ "resourceType": "Microsoft.DataProtection/backupVaults",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/461"
+ },
+ "input": {
+ "$ref": "#/515"
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "exportBackupJobs",
+ "resourceType": "Microsoft.DataProtection/backupVaults",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "undelete",
+ "resourceType": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "apiVersion": "2025-02-01"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UnlockDeleteRequest",
+ "properties": {
+ "resourceGuardOperationRequests": {
+ "type": {
+ "$ref": "#/520"
+ },
+ "flags": 0,
+ "description": "ResourceGuardOperationRequests on which LAC check will be performed"
+ },
+ "resourceToBeDeleted": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/0"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UnlockDeleteResponse",
+ "properties": {
+ "unlockDeleteExpiryTime": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 0,
+ "description": "This is the time when unlock delete privileges will get expired."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "unlockDelete",
+ "resourceType": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies",
+ "apiVersion": "2025-02-01",
+ "output": {
+ "$ref": "#/521"
+ },
+ "input": {
+ "$ref": "#/519"
+ }
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/dell/dell.storage/2025-03-21-preview/types.json b/internal/azure/generated/dell/dell.storage/2025-03-21-preview/types.json
new file mode 100644
index 000000000..86bda7ff8
--- /dev/null
+++ b/internal/azure/generated/dell/dell.storage/2025-03-21-preview/types.json
@@ -0,0 +1,732 @@
+[
+ {
+ "$type": "StringType",
+ "pattern": "^[a-zA-Z0-9_-]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Dell.Storage/filesystems"
+ },
+ {
+ "$type": "StringType"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2025-03-21-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Dell.Storage/filesystems",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
+ },
+ "name": {
+ "type": {
+ "$ref": "#/0"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/1"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/3"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/5"
+ },
+ "flags": 0,
+ "description": "The resource-specific properties for this resource."
+ },
+ "identity": {
+ "type": {
+ "$ref": "#/34"
+ },
+ "flags": 0,
+ "description": "The managed service identities assigned to this resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/43"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LiftrBaseStorageFileSystemResourceProperties",
+ "properties": {
+ "capacity": {
+ "type": {
+ "$ref": "#/6"
+ },
+ "flags": 0,
+ "description": "Capacity for Dell Filesystem, Will be received as part of Job Status"
+ },
+ "marketplace": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 1,
+ "description": "Marketplace details"
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/22"
+ },
+ "flags": 2,
+ "description": "Provisioning State of the resource"
+ },
+ "delegatedSubnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Delegated subnet id for Vnet injection"
+ },
+ "delegatedSubnetCidr": {
+ "type": {
+ "$ref": "#/23"
+ },
+ "flags": 1,
+ "description": "Domain range for the delegated subnet"
+ },
+ "user": {
+ "type": {
+ "$ref": "#/24"
+ },
+ "flags": 1,
+ "description": "User Details"
+ },
+ "fileSystemId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "File system Id of the resource"
+ },
+ "smartConnectFqdn": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Smart Connect FQDN of the resource"
+ },
+ "oneFsUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "OneFS url"
+ },
+ "dellReferenceNumber": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "DellReferenceNumber of the resource"
+ },
+ "encryption": {
+ "type": {
+ "$ref": "#/26"
+ },
+ "flags": 1,
+ "description": "EncryptionProperties of the resource"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LiftrBaseStorageCapacity",
+ "properties": {
+ "min": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Minimum Capacity"
+ },
+ "max": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Maximum Capacity"
+ },
+ "incremental": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Units to be increased"
+ },
+ "current": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Current Capacity of the resource"
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LiftrBaseMarketplaceDetails",
+ "properties": {
+ "marketplaceSubscriptionId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Marketplace Subscription Id"
+ },
+ "planId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Plan Id"
+ },
+ "offerId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Offer Id"
+ },
+ "publisherId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Publisher Id"
+ },
+ "privateOfferId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Private Offer Id"
+ },
+ "planName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "Plan Name"
+ },
+ "marketplaceSubscriptionStatus": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 2,
+ "description": "Marketplace subscription status"
+ },
+ "endDate": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "End Date of the subscription"
+ },
+ "termUnit": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Term Unit"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PendingFulfillmentStart"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Subscribed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Suspended"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Unsubscribed"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/8"
+ },
+ {
+ "$ref": "#/9"
+ },
+ {
+ "$ref": "#/10"
+ },
+ {
+ "$ref": "#/11"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Accepted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Updating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleted"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "NotSpecified"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/13"
+ },
+ {
+ "$ref": "#/14"
+ },
+ {
+ "$ref": "#/15"
+ },
+ {
+ "$ref": "#/16"
+ },
+ {
+ "$ref": "#/17"
+ },
+ {
+ "$ref": "#/18"
+ },
+ {
+ "$ref": "#/19"
+ },
+ {
+ "$ref": "#/20"
+ },
+ {
+ "$ref": "#/21"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}/(16|24)$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LiftrBaseUserDetails",
+ "properties": {
+ "email": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 1,
+ "description": "User Email"
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "sensitive": true
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LiftrBaseEncryptionProperties",
+ "properties": {
+ "encryptionType": {
+ "type": {
+ "$ref": "#/29"
+ },
+ "flags": 1,
+ "description": "Encryption Type - MMK/CMK"
+ },
+ "keyUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Versioned Encryption Key Url - Only when user opts for CMK and hence optional"
+ },
+ "encryptionIdentityProperties": {
+ "type": {
+ "$ref": "#/30"
+ },
+ "flags": 0,
+ "description": "Identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault - Only when user opts for CMK and hence optional"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft-managed keys (MMK)"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Customer-managed keys (CMK)"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/27"
+ },
+ {
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "LiftrBaseEncryptionIdentityProperties",
+ "properties": {
+ "identityType": {
+ "type": {
+ "$ref": "#/33"
+ },
+ "flags": 0,
+ "description": "Identity type - SystemAssigned/UserAssigned - Only UserAssigned is supported now"
+ },
+ "identityResourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User-assigned identity resource id - Only when user opts for UserAssigned identity and hence optional"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/31"
+ },
+ {
+ "$ref": "#/32"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/40"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/42"
+ },
+ "flags": 0,
+ "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned,UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/36"
+ },
+ {
+ "$ref": "#/37"
+ },
+ {
+ "$ref": "#/38"
+ },
+ {
+ "$ref": "#/39"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 2,
+ "description": "The principal ID of the assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/35"
+ },
+ "flags": 2,
+ "description": "The client ID of the assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/41"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SystemData",
+ "properties": {
+ "createdBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": {
+ "$ref": "#/49"
+ },
+ "flags": 0,
+ "description": "The type of identity that created the resource."
+ },
+ "createdAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": {
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "The type of identity that last modified the resource."
+ },
+ "lastModifiedAt": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/46"
+ },
+ {
+ "$ref": "#/47"
+ },
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/51"
+ },
+ {
+ "$ref": "#/52"
+ },
+ {
+ "$ref": "#/53"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Dell.Storage/filesystems@2025-03-21-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
+ }
+]
\ No newline at end of file
diff --git a/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-08-08-preview/types.json b/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-08-08-preview/types.json
index 594636eee..fdb9770cc 100644
--- a/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-08-08-preview/types.json
+++ b/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-08-08-preview/types.json
@@ -1,13 +1,13 @@
[
{
"$type": "StringType",
- "minLength": 1,
- "maxLength": 255,
- "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
+ "minLength": 3,
+ "maxLength": 100,
+ "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$"
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/workspaces"
+ "value": "Microsoft.DesktopVirtualization/appAttachPackages"
},
{
"$type": "StringType"
@@ -18,7 +18,7 @@
},
{
"$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/workspaces",
+ "name": "Microsoft.DesktopVirtualization/appAttachPackages",
"properties": {
"id": {
"type": {
@@ -52,54 +52,12 @@
"type": {
"$ref": "#/5"
},
- "flags": 0,
- "description": "Detailed properties for Workspace"
- },
- "managedBy": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
- },
- "kind": {
- "type": {
- "$ref": "#/37"
- },
- "flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
- },
- "etag": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 2,
- "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
- },
- "identity": {
- "type": {
- "$ref": "#/38"
- },
- "flags": 0,
- "description": "Managed service identity (system assigned and/or user assigned identities)"
- },
- "sku": {
- "type": {
- "$ref": "#/47"
- },
- "flags": 0,
- "description": "The resource model definition representing SKU"
- },
- "plan": {
- "type": {
- "$ref": "#/54"
- },
- "flags": 0,
- "description": "Plan for the resource."
+ "flags": 1,
+ "description": "Detailed properties for App Attach Package"
},
"tags": {
"type": {
- "$ref": "#/55"
+ "$ref": "#/26"
},
"flags": 0,
"description": "Resource tags."
@@ -113,7 +71,7 @@
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -122,79 +80,91 @@
},
{
"$type": "ObjectType",
- "name": "WorkspaceProperties",
+ "name": "AppAttachPackageProperties",
"properties": {
- "objectId": {
+ "provisioningState": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/10"
},
"flags": 2,
- "description": "ObjectId of Workspace. (internal use)"
+ "description": "The provisioning state of the App Attach Package."
},
- "description": {
+ "image": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/11"
},
"flags": 0,
- "description": "Description of Workspace."
+ "description": "Detailed properties for App Attach Package"
},
- "friendlyName": {
+ "hostPoolReferences": {
+ "type": {
+ "$ref": "#/21"
+ },
+ "flags": 0,
+ "description": "List of Hostpool resource Ids."
+ },
+ "keyVaultURL": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Friendly name of Workspace."
+ "description": "URL path to certificate name located in keyVault"
},
- "applicationGroupReferences": {
+ "failHealthCheckOnStagingFailure": {
"type": {
- "$ref": "#/6"
+ "$ref": "#/25"
},
"flags": 0,
- "description": "List of applicationGroup resource Ids."
+ "description": "Parameter indicating how the health check should behave if this package fails staging"
},
- "cloudPcResource": {
+ "packageOwnerName": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "Is cloud pc resource."
+ "flags": 0,
+ "description": "Specific name of package owner, is \"AppAttach\" for native app attach packages"
},
- "publicNetworkAccess": {
+ "packageLookbackUrl": {
"type": {
- "$ref": "#/10"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints"
+ "description": "Lookback url to third party control plane, is null for native app attach packages"
},
- "privateEndpointConnections": {
+ "customData": {
"type": {
- "$ref": "#/36"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "List of private endpoint connection associated with the specified resource"
+ "flags": 0,
+ "description": "Field that can be populated with custom data and filtered on in list GET calls"
}
}
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/2"
- }
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
},
{
- "$type": "BooleanType"
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
},
{
"$type": "StringLiteralType",
- "value": "Enabled"
+ "value": "Failed"
},
{
"$type": "StringLiteralType",
- "value": "Disabled"
+ "value": "Canceled"
},
{
"$type": "UnionType",
"elements": [
+ {
+ "$ref": "#/6"
+ },
+ {
+ "$ref": "#/7"
+ },
{
"$ref": "#/8"
},
@@ -208,148 +178,238 @@
},
{
"$type": "ObjectType",
- "name": "PrivateEndpointConnection",
+ "name": "AppAttachPackageInfoProperties",
"properties": {
- "properties": {
+ "packageAlias": {
"type": {
- "$ref": "#/12"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Resource properties."
+ "description": "Alias of App Attach Package. Assigned at import time"
},
- "id": {
+ "imagePath": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ "flags": 0,
+ "description": "VHD/CIM image path on Network Share."
},
- "name": {
+ "packageName": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The name of the resource"
+ "flags": 0,
+ "description": "Package Name from appxmanifest.xml."
},
- "type": {
+ "packageFamilyName": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ "flags": 0,
+ "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name."
},
- "systemData": {
+ "packageFullName": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "PrivateEndpointConnectionProperties",
- "properties": {
- "groupIds": {
+ "flags": 0,
+ "description": "Package Full Name from appxmanifest.xml."
+ },
+ "displayName": {
"type": {
- "$ref": "#/13"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "The group ids for the private endpoint resource."
+ "flags": 0,
+ "description": "User friendly Name to be displayed in the portal."
},
- "privateEndpoint": {
+ "packageRelativePath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Relative Path to the package inside the image."
+ },
+ "isRegularRegistration": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Specifies how to register Package in feed."
+ },
+ "isActive": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Make this version of the package the active one across the hostpool."
+ },
+ "packageDependencies": {
"type": {
"$ref": "#/14"
},
"flags": 0,
- "description": "The private endpoint resource."
+ "description": "List of package dependencies."
},
- "privateLinkServiceConnectionState": {
+ "version": {
"type": {
- "$ref": "#/15"
+ "$ref": "#/2"
},
- "flags": 1,
- "description": "A collection of information about the state of the connection between service consumer and provider."
+ "flags": 0,
+ "description": "Package version found in the appxmanifest.xml."
},
- "provisioningState": {
+ "lastUpdated": {
"type": {
- "$ref": "#/24"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "The provisioning state of the private endpoint connection resource."
- }
- }
- },
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/2"
- }
- },
- {
- "$type": "ObjectType",
- "name": "PrivateEndpoint",
- "properties": {
- "id": {
+ "flags": 0,
+ "description": "Date Package was last updated, found in the appxmanifest.xml."
+ },
+ "packageApplications": {
+ "type": {
+ "$ref": "#/17"
+ },
+ "flags": 0,
+ "description": "List of package applications."
+ },
+ "certificateName": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The ARM identifier for private endpoint."
+ "flags": 0,
+ "description": "Certificate name found in the appxmanifest.xml."
+ },
+ "certificateExpiry": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Date certificate expires, found in the appxmanifest.xml."
+ },
+ "isPackageTimestamped": {
+ "type": {
+ "$ref": "#/20"
+ },
+ "flags": 0,
+ "description": "Is package timestamped so it can ignore the certificate expiry date"
}
}
},
+ {
+ "$type": "BooleanType"
+ },
{
"$type": "ObjectType",
- "name": "PrivateLinkServiceConnectionState",
+ "name": "MsixPackageDependencies",
"properties": {
- "status": {
+ "dependencyName": {
"type": {
- "$ref": "#/19"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
+ "description": "Name of package dependency."
},
- "description": {
+ "publisher": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "The reason for approval/rejection of the connection."
+ "description": "Name of dependency publisher."
},
- "actionsRequired": {
+ "minVersion": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "A message indicating if changes on the service provider require any updates on the consumer."
+ "description": "Dependency version required."
}
}
},
{
- "$type": "StringLiteralType",
- "value": "Pending"
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/13"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MsixPackageApplications",
+ "properties": {
+ "appId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Package Application Id, found in appxmanifest.xml."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Description of Package Application."
+ },
+ "appUserModelID": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml."
+ },
+ "friendlyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User friendly name."
+ },
+ "iconImageName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "User friendly name."
+ },
+ "rawIcon": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "the icon a 64 bit string as a byte array."
+ },
+ "rawPng": {
+ "type": {
+ "$ref": "#/16"
+ },
+ "flags": 0,
+ "description": "the icon a 64 bit string as a byte array."
+ }
+ }
+ },
+ {
+ "$type": "AnyType"
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/15"
+ }
},
{
"$type": "StringLiteralType",
- "value": "Approved"
+ "value": "Timestamped"
},
{
"$type": "StringLiteralType",
- "value": "Rejected"
+ "value": "NotTimestamped"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/16"
- },
- {
- "$ref": "#/17"
+ "$ref": "#/18"
},
{
- "$ref": "#/18"
+ "$ref": "#/19"
},
{
"$ref": "#/2"
@@ -357,41 +417,48 @@
]
},
{
- "$type": "StringLiteralType",
- "value": "Succeeded"
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
},
{
"$type": "StringLiteralType",
- "value": "Creating"
+ "value": "Unhealthy"
},
{
"$type": "StringLiteralType",
- "value": "Deleting"
+ "value": "NeedsAssistance"
},
{
"$type": "StringLiteralType",
- "value": "Failed"
+ "value": "DoNotFail"
},
{
"$type": "UnionType",
"elements": [
- {
- "$ref": "#/20"
- },
- {
- "$ref": "#/21"
- },
{
"$ref": "#/22"
},
{
"$ref": "#/23"
},
+ {
+ "$ref": "#/24"
+ },
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
{
"$type": "ObjectType",
"name": "SystemData",
@@ -405,7 +472,7 @@
},
"createdByType": {
"type": {
- "$ref": "#/30"
+ "$ref": "#/32"
},
"flags": 0,
"description": "The type of identity that created the resource."
@@ -426,7 +493,7 @@
},
"lastModifiedByType": {
"type": {
- "$ref": "#/35"
+ "$ref": "#/37"
},
"flags": 0,
"description": "The type of identity that last modified the resource."
@@ -460,16 +527,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/26"
+ "$ref": "#/28"
},
{
- "$ref": "#/27"
+ "$ref": "#/29"
},
{
- "$ref": "#/28"
+ "$ref": "#/30"
},
{
- "$ref": "#/29"
+ "$ref": "#/31"
},
{
"$ref": "#/2"
@@ -496,16 +563,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/31"
+ "$ref": "#/33"
},
{
- "$ref": "#/32"
+ "$ref": "#/34"
},
{
- "$ref": "#/33"
+ "$ref": "#/35"
},
{
- "$ref": "#/34"
+ "$ref": "#/36"
},
{
"$ref": "#/2"
@@ -513,182 +580,275 @@
]
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/11"
- }
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/appAttachPackages@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/4"
+ },
+ "flags": 0
},
{
"$type": "StringType",
- "pattern": "^[-\\w\\._,\\(\\)]+$"
+ "minLength": 3,
+ "maxLength": 64,
+ "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/applicationGroups"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-08-08-preview"
},
{
"$type": "ObjectType",
- "name": "ManagedServiceIdentity",
+ "name": "Microsoft.DesktopVirtualization/applicationGroups",
"properties": {
- "principalId": {
+ "id": {
"type": {
- "$ref": "#/39"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ "flags": 10,
+ "description": "The resource id"
},
- "tenantId": {
+ "name": {
"type": {
"$ref": "#/39"
},
- "flags": 2,
- "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ "flags": 9,
+ "description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/44"
+ "$ref": "#/40"
},
- "flags": 1,
- "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)."
+ "flags": 10,
+ "description": "The resource type"
},
- "userAssignedIdentities": {
+ "apiVersion": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/41"
},
- "flags": 0,
- "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests."
- }
- }
- },
- {
- "$type": "StringType",
- "minLength": 36,
- "maxLength": 36,
- "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "SystemAssigned"
- },
- {
- "$type": "StringLiteralType",
- "value": "UserAssigned"
- },
- {
- "$type": "StringLiteralType",
- "value": "SystemAssigned,UserAssigned"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/40"
- },
- {
- "$ref": "#/41"
- },
- {
- "$ref": "#/42"
- },
- {
- "$ref": "#/43"
+ "flags": 10,
+ "description": "The resource api version"
},
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "ObjectType",
- "name": "UserAssignedIdentity",
- "properties": {
- "principalId": {
+ "properties": {
"type": {
- "$ref": "#/39"
+ "$ref": "#/43"
},
- "flags": 2,
- "description": "The principal ID of the assigned identity."
+ "flags": 1,
+ "description": "Detailed properties for ApplicationGroup"
},
- "clientId": {
+ "identity": {
"type": {
- "$ref": "#/39"
+ "$ref": "#/47"
},
- "flags": 2,
- "description": "The client ID of the assigned identity."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "ManagedServiceIdentityUserAssignedIdentities",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/45"
- }
- },
- {
- "$type": "ObjectType",
- "name": "Sku",
- "properties": {
- "name": {
+ "flags": 0,
+ "description": "The managed service identities assigned to this resource."
+ },
+ "etag": {
"type": {
"$ref": "#/2"
},
- "flags": 1,
- "description": "The name of the SKU. E.g. P3. It is typically a letter+number code"
+ "flags": 2,
+ "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- "tier": {
+ "kind": {
"type": {
- "$ref": "#/52"
+ "$ref": "#/56"
},
"flags": 0,
- "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
- "size": {
+ "managedBy": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
+ "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
},
- "family": {
+ "plan": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/57"
},
"flags": 0,
- "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
+ "description": "Details of the resource plan."
},
- "capacity": {
+ "sku": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/58"
},
"flags": 0,
- "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
+ "description": "The SKU (Stock Keeping Unit) assigned to this resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/65"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ApplicationGroupProperties",
+ "properties": {
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ObjectId of ApplicationGroup. (internal use)"
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Description of ApplicationGroup."
+ },
+ "friendlyName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Friendly name of ApplicationGroup."
+ },
+ "hostPoolArmPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "HostPool arm path of ApplicationGroup."
+ },
+ "workspaceArmPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Workspace arm path of ApplicationGroup."
+ },
+ "applicationGroupType": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 1,
+ "description": "Resource Type of ApplicationGroup."
+ },
+ "cloudPcResource": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 2,
+ "description": "Is cloud pc resource."
+ },
+ "showInFeed": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Boolean representing whether the applicationGroup is show in the feed."
}
}
},
{
"$type": "StringLiteralType",
- "value": "Free"
+ "value": "RemoteApp"
},
{
"$type": "StringLiteralType",
- "value": "Basic"
+ "value": "Desktop"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/44"
+ },
+ {
+ "$ref": "#/45"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/55"
+ },
+ "flags": 0,
+ "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
},
{
"$type": "StringLiteralType",
- "value": "Standard"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "Premium"
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned,UserAssigned"
},
{
"$type": "UnionType",
"elements": [
- {
- "$ref": "#/48"
- },
{
"$ref": "#/49"
},
@@ -697,11 +857,46 @@
},
{
"$ref": "#/51"
+ },
+ {
+ "$ref": "#/52"
+ },
+ {
+ "$ref": "#/2"
}
]
},
{
- "$type": "IntegerType"
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 2,
+ "description": "The principal ID of the assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/48"
+ },
+ "flags": 2,
+ "description": "The client ID of the assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/54"
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[-\\w\\._,\\(\\)]+$"
},
{
"$type": "ObjectType",
@@ -746,154 +941,101 @@
},
{
"$type": "ObjectType",
- "name": "TrackedResourceTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
- }
- },
- {
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/workspaces@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/4"
- },
- "flags": 0
- },
- {
- "$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections"
- },
- {
- "$type": "StringLiteralType",
- "value": "2024-08-08-preview"
- },
- {
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections",
+ "name": "Sku",
"properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
"name": {
"type": {
"$ref": "#/2"
},
- "flags": 9,
- "description": "The resource name"
+ "flags": 1,
+ "description": "The name of the SKU. E.g. P3. It is typically a letter+number code"
},
- "type": {
+ "tier": {
"type": {
- "$ref": "#/57"
+ "$ref": "#/63"
},
- "flags": 10,
- "description": "The resource type"
+ "flags": 0,
+ "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
},
- "apiVersion": {
+ "size": {
"type": {
- "$ref": "#/58"
+ "$ref": "#/2"
},
- "flags": 10,
- "description": "The resource api version"
+ "flags": 0,
+ "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
},
- "properties": {
+ "family": {
"type": {
- "$ref": "#/12"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Resource properties."
+ "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
},
- "systemData": {
+ "capacity": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/64"
},
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ "flags": 0,
+ "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
}
}
},
{
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/59"
- },
- "flags": 0
- },
+ "$type": "StringLiteralType",
+ "value": "Free"
+ },
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections"
+ "value": "Basic"
},
{
"$type": "StringLiteralType",
- "value": "2024-08-08-preview"
+ "value": "Standard"
},
{
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
- "name": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 9,
- "description": "The resource name"
- },
- "type": {
- "type": {
- "$ref": "#/61"
- },
- "flags": 10,
- "description": "The resource type"
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/59"
},
- "apiVersion": {
- "type": {
- "$ref": "#/62"
- },
- "flags": 10,
- "description": "The resource api version"
+ {
+ "$ref": "#/60"
},
- "properties": {
- "type": {
- "$ref": "#/12"
- },
- "flags": 0,
- "description": "Resource properties."
+ {
+ "$ref": "#/61"
},
- "systemData": {
- "type": {
- "$ref": "#/25"
- },
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ {
+ "$ref": "#/62"
}
+ ]
+ },
+ {
+ "$type": "IntegerType"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
}
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2024-08-08-preview",
+ "name": "Microsoft.DesktopVirtualization/applicationGroups@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/63"
+ "$ref": "#/42"
},
"flags": 0
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/scalingPlans"
+ "value": "Microsoft.DesktopVirtualization/hostPools"
},
{
"$type": "StringLiteralType",
@@ -901,7 +1043,7 @@
},
{
"$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans",
+ "name": "Microsoft.DesktopVirtualization/hostPools",
"properties": {
"id": {
"type": {
@@ -912,77 +1054,77 @@
},
"name": {
"type": {
- "$ref": "#/0"
+ "$ref": "#/39"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/65"
+ "$ref": "#/67"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/66"
+ "$ref": "#/68"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/68"
+ "$ref": "#/70"
},
"flags": 1,
- "description": "Detailed properties for scaling plan."
- },
- "managedBy": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
+ "description": "Detailed properties for HostPool"
},
- "kind": {
+ "identity": {
"type": {
- "$ref": "#/37"
+ "$ref": "#/47"
},
"flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ "description": "The managed service identities assigned to this resource."
},
"etag": {
"type": {
"$ref": "#/2"
},
"flags": 2,
- "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- "identity": {
+ "kind": {
"type": {
- "$ref": "#/38"
+ "$ref": "#/56"
},
"flags": 0,
- "description": "Managed service identity (system assigned and/or user assigned identities)"
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
- "sku": {
+ "managedBy": {
"type": {
- "$ref": "#/47"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "The resource model definition representing SKU"
+ "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
},
"plan": {
"type": {
- "$ref": "#/54"
+ "$ref": "#/57"
+ },
+ "flags": 0,
+ "description": "Details of the resource plan."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/58"
},
"flags": 0,
- "description": "Plan for the resource."
+ "description": "The SKU (Stock Keeping Unit) assigned to this resource."
},
"tags": {
"type": {
- "$ref": "#/105"
+ "$ref": "#/152"
},
"flags": 0,
"description": "Resource tags."
@@ -996,7 +1138,7 @@
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -1005,321 +1147,345 @@
},
{
"$type": "ObjectType",
- "name": "ScalingPlanProperties",
+ "name": "HostPoolProperties",
"properties": {
"objectId": {
"type": {
"$ref": "#/2"
},
"flags": 2,
- "description": "ObjectId of scaling plan. (internal use)"
+ "description": "ObjectId of HostPool. (internal use)"
},
- "description": {
+ "friendlyName": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Description of scaling plan."
+ "description": "Friendly name of HostPool."
},
- "friendlyName": {
+ "description": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "User friendly name of scaling plan."
+ "description": "Description of HostPool."
},
- "timeZone": {
+ "hostPoolType": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/74"
},
"flags": 1,
- "description": "Timezone of the scaling plan."
+ "description": "HostPool type for desktop."
},
- "hostPoolType": {
+ "personalDesktopAssignmentType": {
"type": {
- "$ref": "#/71"
+ "$ref": "#/77"
},
"flags": 0,
- "description": "HostPool type for desktop."
+ "description": "PersonalDesktopAssignment type for HostPool."
},
- "exclusionTag": {
+ "customRdpProperty": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Exclusion tag for scaling plan."
+ "description": "Custom rdp property of HostPool."
},
- "schedules": {
+ "maxSessionLimit": {
"type": {
- "$ref": "#/102"
+ "$ref": "#/64"
},
"flags": 0,
- "description": "List of Pooled ScalingSchedule definitions."
+ "description": "The max session limit of HostPool."
},
- "hostPoolReferences": {
+ "loadBalancerType": {
"type": {
- "$ref": "#/104"
+ "$ref": "#/82"
},
- "flags": 0,
- "description": "List of ScalingHostPoolReference definitions."
- }
- }
- },
- {
- "$type": "StringLiteralType",
- "value": "Pooled"
- },
- {
- "$type": "StringLiteralType",
- "value": "Personal"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/69"
- },
- {
- "$ref": "#/70"
+ "flags": 1,
+ "description": "The type of the load balancer."
},
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "ObjectType",
- "name": "ScalingSchedule",
- "properties": {
- "name": {
+ "ring": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/64"
},
"flags": 0,
- "description": "Name of the ScalingPlanPooledSchedule."
+ "description": "The ring number of HostPool."
},
- "daysOfWeek": {
+ "validationEnvironment": {
"type": {
- "$ref": "#/81"
+ "$ref": "#/12"
},
"flags": 0,
- "description": "Set of days of the week on which this schedule is active."
+ "description": "Is validation environment."
},
- "rampUpStartTime": {
+ "registrationInfo": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/83"
},
"flags": 0,
- "description": "Starting time for ramp up period."
+ "description": "The registration info of HostPool."
},
- "rampUpLoadBalancingAlgorithm": {
+ "vmTemplate": {
"type": {
- "$ref": "#/87"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Load balancing algorithm for ramp up period."
+ "description": "VM template for sessionhosts configuration within hostpool."
},
- "rampUpMinimumHostsPct": {
+ "applicationGroupReferences": {
"type": {
"$ref": "#/88"
},
- "flags": 0,
- "description": "Minimum host percentage for ramp up period."
+ "flags": 2,
+ "description": "List of applicationGroup links."
},
- "rampUpCapacityThresholdPct": {
+ "appAttachPackageReferences": {
"type": {
"$ref": "#/89"
},
- "flags": 0,
- "description": "Capacity threshold for ramp up period."
+ "flags": 2,
+ "description": "List of App Attach Package links."
},
- "peakStartTime": {
+ "ssoadfsAuthority": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Starting time for peak period."
+ "description": "URL to customer ADFS server for signing WVD SSO certificates."
},
- "peakLoadBalancingAlgorithm": {
+ "ssoClientId": {
"type": {
- "$ref": "#/92"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Load balancing algorithm for peak period."
+ "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates."
},
- "rampDownStartTime": {
+ "ssoClientSecretKeyVaultPath": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Starting time for ramp down period."
+ "description": "Path to Azure KeyVault storing the secret used for communication to ADFS."
},
- "rampDownLoadBalancingAlgorithm": {
+ "ssoSecretType": {
"type": {
- "$ref": "#/95"
+ "$ref": "#/94"
},
"flags": 0,
- "description": "Load balancing algorithm for ramp down period."
+ "description": "The type of single sign on Secret Type."
},
- "rampDownMinimumHostsPct": {
+ "preferredAppGroupType": {
"type": {
- "$ref": "#/88"
+ "$ref": "#/98"
},
- "flags": 0,
- "description": "Minimum host percentage for ramp down period."
+ "flags": 1,
+ "description": "The type of preferred application group type, default to Desktop Application Group"
},
- "rampDownCapacityThresholdPct": {
+ "startVMOnConnect": {
"type": {
- "$ref": "#/89"
+ "$ref": "#/12"
},
"flags": 0,
- "description": "Capacity threshold for ramp down period."
+ "description": "The flag to turn on/off StartVMOnConnect feature."
},
- "rampDownForceLogoffUsers": {
+ "cloudPcResource": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/12"
},
- "flags": 0,
- "description": "Should users be logged off forcefully from hosts."
+ "flags": 2,
+ "description": "Is cloud pc resource."
},
- "rampDownStopHostsWhen": {
+ "publicNetworkAccess": {
"type": {
- "$ref": "#/98"
+ "$ref": "#/103"
},
"flags": 0,
- "description": "Specifies when to stop hosts during ramp down period."
+ "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints"
},
- "rampDownWaitTimeMinutes": {
+ "agentUpdate": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/104"
},
"flags": 0,
- "description": "Number of minutes to wait to stop hosts during ramp down period."
+ "description": "The session host configuration for updating agent, monitoring agent, and stack component."
},
- "rampDownNotificationMessage": {
+ "privateEndpointConnections": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/132"
+ },
+ "flags": 2,
+ "description": "List of private endpoint connection associated with the specified resource"
+ },
+ "managedPrivateUDP": {
+ "type": {
+ "$ref": "#/136"
},
"flags": 0,
- "description": "Notification message for users during ramp down period."
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
},
- "offPeakStartTime": {
+ "directUDP": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/140"
},
"flags": 0,
- "description": "Starting time for off-peak period."
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
},
- "offPeakLoadBalancingAlgorithm": {
+ "publicUDP": {
"type": {
- "$ref": "#/101"
+ "$ref": "#/144"
},
"flags": 0,
- "description": "Load balancing algorithm for off-peak period."
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ },
+ "relayUDP": {
+ "type": {
+ "$ref": "#/148"
+ },
+ "flags": 0,
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ },
+ "managementType": {
+ "type": {
+ "$ref": "#/151"
+ },
+ "flags": 0,
+ "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated."
}
}
},
{
"$type": "StringLiteralType",
- "value": "Monday"
- },
- {
- "$type": "StringLiteralType",
- "value": "Tuesday"
+ "value": "Personal"
},
{
"$type": "StringLiteralType",
- "value": "Wednesday"
+ "value": "Pooled"
},
{
"$type": "StringLiteralType",
- "value": "Thursday"
+ "value": "BYODesktop"
},
{
- "$type": "StringLiteralType",
- "value": "Friday"
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/71"
+ },
+ {
+ "$ref": "#/72"
+ },
+ {
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
},
{
"$type": "StringLiteralType",
- "value": "Saturday"
+ "value": "Automatic"
},
{
"$type": "StringLiteralType",
- "value": "Sunday"
+ "value": "Direct"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/73"
+ "$ref": "#/75"
},
{
- "$ref": "#/74"
+ "$ref": "#/76"
},
{
- "$ref": "#/75"
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BreadthFirst"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DepthFirst"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Persistent"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiplePersistent"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/78"
},
{
- "$ref": "#/76"
+ "$ref": "#/79"
},
{
- "$ref": "#/77"
+ "$ref": "#/80"
},
{
- "$ref": "#/78"
+ "$ref": "#/81"
},
{
- "$ref": "#/79"
+ "$ref": "#/2"
}
]
},
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/80"
- }
- },
{
"$type": "ObjectType",
- "name": "Time",
+ "name": "RegistrationInfo",
"properties": {
- "hour": {
+ "expirationTime": {
"type": {
- "$ref": "#/83"
+ "$ref": "#/2"
},
- "flags": 1,
- "description": "The hour."
+ "flags": 0,
+ "description": "Expiration time of registration token."
},
- "minute": {
+ "token": {
"type": {
- "$ref": "#/84"
+ "$ref": "#/2"
},
- "flags": 1,
- "description": "The minute."
+ "flags": 0,
+ "description": "The registration token base64 encoded string."
+ },
+ "registrationTokenOperation": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "The type of resetting the token."
}
}
},
{
- "$type": "IntegerType",
- "minValue": 0,
- "maxValue": 23
- },
- {
- "$type": "IntegerType",
- "minValue": 0,
- "maxValue": 59
+ "$type": "StringLiteralType",
+ "value": "Delete"
},
{
"$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
+ "value": "Update"
},
{
"$type": "UnionType",
"elements": [
+ {
+ "$ref": "#/84"
+ },
{
"$ref": "#/85"
},
@@ -1332,53 +1498,47 @@
]
},
{
- "$type": "IntegerType",
- "minValue": 0,
- "maxValue": 100
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
},
{
- "$type": "IntegerType",
- "minValue": 1,
- "maxValue": 100
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
},
{
"$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "value": "SharedKey"
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/90"
- },
- {
- "$ref": "#/91"
- },
- {
- "$ref": "#/2"
- }
- ]
+ "value": "Certificate"
},
{
"$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "value": "SharedKeyInKeyVault"
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
+ "value": "CertificateInKeyVault"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/93"
+ "$ref": "#/90"
+ },
+ {
+ "$ref": "#/91"
+ },
+ {
+ "$ref": "#/92"
},
{
- "$ref": "#/94"
+ "$ref": "#/93"
},
{
"$ref": "#/2"
@@ -1387,15 +1547,22 @@
},
{
"$type": "StringLiteralType",
- "value": "ZeroSessions"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "ZeroActiveSessions"
+ "value": "Desktop"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "RailApplications"
},
{
"$type": "UnionType",
"elements": [
+ {
+ "$ref": "#/95"
+ },
{
"$ref": "#/96"
},
@@ -1409,11 +1576,19 @@
},
{
"$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "value": "Enabled"
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
+ "value": "Disabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EnabledForSessionHostsOnly"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "EnabledForClientsOnly"
},
{
"$type": "UnionType",
@@ -1424,251 +1599,90 @@
{
"$ref": "#/100"
},
+ {
+ "$ref": "#/101"
+ },
+ {
+ "$ref": "#/102"
+ },
{
"$ref": "#/2"
}
]
},
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/72"
- }
- },
{
"$type": "ObjectType",
- "name": "ScalingHostPoolReference",
+ "name": "AgentUpdateProperties",
"properties": {
- "hostPoolArmPath": {
+ "type": {
+ "type": {
+ "$ref": "#/107"
+ },
+ "flags": 0,
+ "description": "The type of maintenance for session host components."
+ },
+ "useSessionHostLocalTime": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Whether to use localTime of the virtual machine."
+ },
+ "maintenanceWindowTimeZone": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Arm path of referenced hostpool."
+ "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true."
},
- "scalingPlanEnabled": {
+ "maintenanceWindows": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/117"
},
"flags": 0,
- "description": "Is the scaling plan enabled for this hostpool."
+ "description": "List of maintenance windows. Maintenance windows are 2 hours long."
}
}
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/103"
- }
+ "$type": "StringLiteralType",
+ "value": "Default"
},
{
- "$type": "ObjectType",
- "name": "TrackedResourceTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
- }
+ "$type": "StringLiteralType",
+ "value": "Scheduled"
},
{
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/67"
- },
- "flags": 0
- },
- {
- "$type": "StringType",
- "minLength": 1,
- "maxLength": 64,
- "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
- },
- {
- "$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules"
- },
- {
- "$type": "StringLiteralType",
- "value": "2024-08-08-preview"
- },
- {
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
- "name": {
- "type": {
- "$ref": "#/107"
- },
- "flags": 9,
- "description": "The resource name"
- },
- "type": {
- "type": {
- "$ref": "#/108"
- },
- "flags": 10,
- "description": "The resource type"
- },
- "apiVersion": {
- "type": {
- "$ref": "#/109"
- },
- "flags": 10,
- "description": "The resource api version"
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/105"
},
- "properties": {
- "type": {
- "$ref": "#/111"
- },
- "flags": 1,
- "description": "Detailed properties for ScalingPlanPooledSchedule"
+ {
+ "$ref": "#/106"
},
- "systemData": {
- "type": {
- "$ref": "#/25"
- },
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ {
+ "$ref": "#/2"
}
- }
+ ]
},
{
"$type": "ObjectType",
- "name": "ScalingPlanPooledScheduleProperties",
+ "name": "MaintenanceWindowProperties",
"properties": {
- "name": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 2,
- "description": "Name of the ScalingPlanPooledSchedule."
- },
- "daysOfWeek": {
- "type": {
- "$ref": "#/120"
- },
- "flags": 1,
- "description": "Set of days of the week on which this schedule is active."
- },
- "rampUpStartTime": {
- "type": {
- "$ref": "#/82"
- },
- "flags": 1,
- "description": "Starting time for ramp up period."
- },
- "rampUpLoadBalancingAlgorithm": {
- "type": {
- "$ref": "#/123"
- },
- "flags": 0,
- "description": "Load balancing algorithm for ramp up period."
- },
- "rampUpMinimumHostsPct": {
- "type": {
- "$ref": "#/88"
- },
- "flags": 0,
- "description": "Minimum host percentage for ramp up period."
- },
- "rampUpCapacityThresholdPct": {
- "type": {
- "$ref": "#/89"
- },
- "flags": 1,
- "description": "Capacity threshold for ramp up period."
- },
- "peakStartTime": {
- "type": {
- "$ref": "#/82"
- },
- "flags": 1,
- "description": "Starting time for peak period."
- },
- "peakLoadBalancingAlgorithm": {
- "type": {
- "$ref": "#/126"
- },
- "flags": 0,
- "description": "Load balancing algorithm for peak period."
- },
- "rampDownStartTime": {
- "type": {
- "$ref": "#/82"
- },
- "flags": 1,
- "description": "Starting time for ramp down period."
- },
- "rampDownLoadBalancingAlgorithm": {
- "type": {
- "$ref": "#/129"
- },
- "flags": 0,
- "description": "Load balancing algorithm for ramp down period."
- },
- "rampDownMinimumHostsPct": {
- "type": {
- "$ref": "#/88"
- },
- "flags": 0,
- "description": "Minimum host percentage for ramp down period."
- },
- "rampDownCapacityThresholdPct": {
- "type": {
- "$ref": "#/89"
- },
- "flags": 1,
- "description": "Capacity threshold for ramp down period."
- },
- "rampDownForceLogoffUsers": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Should users be logged off forcefully from hosts."
- },
- "rampDownStopHostsWhen": {
- "type": {
- "$ref": "#/132"
- },
- "flags": 0,
- "description": "Specifies when to stop hosts during ramp down period."
- },
- "rampDownWaitTimeMinutes": {
- "type": {
- "$ref": "#/53"
- },
- "flags": 0,
- "description": "Number of minutes to wait to stop hosts during ramp down period."
- },
- "rampDownNotificationMessage": {
+ "hour": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/64"
},
"flags": 0,
- "description": "Notification message for users during ramp down period."
- },
- "offPeakStartTime": {
- "type": {
- "$ref": "#/82"
- },
- "flags": 1,
- "description": "Starting time for off-peak period."
+ "description": "The update start hour of the day. (0 - 23)"
},
- "offPeakLoadBalancingAlgorithm": {
+ "dayOfWeek": {
"type": {
- "$ref": "#/135"
+ "$ref": "#/116"
},
"flags": 0,
- "description": "Load balancing algorithm for off-peak period."
+ "description": "Day of the week."
}
}
},
@@ -1704,71 +1718,177 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/112"
+ "$ref": "#/109"
},
{
- "$ref": "#/113"
+ "$ref": "#/110"
},
{
- "$ref": "#/114"
+ "$ref": "#/111"
},
{
- "$ref": "#/115"
+ "$ref": "#/112"
},
{
- "$ref": "#/116"
+ "$ref": "#/113"
},
{
- "$ref": "#/117"
+ "$ref": "#/114"
},
{
- "$ref": "#/118"
+ "$ref": "#/115"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/119"
+ "$ref": "#/108"
}
},
{
- "$type": "StringLiteralType",
- "value": "BreadthFirst"
- },
- {
- "$type": "StringLiteralType",
- "value": "DepthFirst"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/121"
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnection",
+ "properties": {
+ "properties": {
+ "type": {
+ "$ref": "#/119"
+ },
+ "flags": 0,
+ "description": "Resource properties."
},
- {
- "$ref": "#/122"
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
},
- {
- "$ref": "#/2"
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "BreadthFirst"
- },
- {
- "$type": "StringLiteralType",
- "value": "DepthFirst"
+ }
},
{
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/124"
- },
- {
+ "$type": "ObjectType",
+ "name": "PrivateEndpointConnectionProperties",
+ "properties": {
+ "groupIds": {
+ "type": {
+ "$ref": "#/120"
+ },
+ "flags": 2,
+ "description": "The group ids for the private endpoint resource."
+ },
+ "privateEndpoint": {
+ "type": {
+ "$ref": "#/121"
+ },
+ "flags": 0,
+ "description": "The private endpoint resource."
+ },
+ "privateLinkServiceConnectionState": {
+ "type": {
+ "$ref": "#/122"
+ },
+ "flags": 1,
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "type": {
+ "$ref": "#/131"
+ },
+ "flags": 2,
+ "description": "The provisioning state of the private endpoint connection resource."
+ }
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateEndpoint",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The ARM identifier for private endpoint."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "PrivateLinkServiceConnectionState",
+ "properties": {
+ "status": {
+ "type": {
+ "$ref": "#/126"
+ },
+ "flags": 0,
+ "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
+ },
+ "description": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The reason for approval/rejection of the connection."
+ },
+ "actionsRequired": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "A message indicating if changes on the service provider require any updates on the consumer."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pending"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Approved"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Rejected"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/123"
+ },
+ {
+ "$ref": "#/124"
+ },
+ {
"$ref": "#/125"
},
{
@@ -1778,11 +1898,19 @@
},
{
"$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "value": "Succeeded"
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
+ "value": "Creating"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deleting"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
},
{
"$type": "UnionType",
@@ -1793,27 +1921,46 @@
{
"$ref": "#/128"
},
+ {
+ "$ref": "#/129"
+ },
+ {
+ "$ref": "#/130"
+ },
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/118"
+ }
+ },
{
"$type": "StringLiteralType",
- "value": "ZeroSessions"
+ "value": "Default"
},
{
"$type": "StringLiteralType",
- "value": "ZeroActiveSessions"
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/130"
+ "$ref": "#/133"
+ },
+ {
+ "$ref": "#/134"
},
{
- "$ref": "#/131"
+ "$ref": "#/135"
},
{
"$ref": "#/2"
@@ -1822,38 +1969,133 @@
},
{
"$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "value": "Default"
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/133"
+ "$ref": "#/137"
},
{
- "$ref": "#/134"
+ "$ref": "#/138"
+ },
+ {
+ "$ref": "#/139"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/141"
+ },
+ {
+ "$ref": "#/142"
+ },
+ {
+ "$ref": "#/143"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/145"
+ },
+ {
+ "$ref": "#/146"
+ },
+ {
+ "$ref": "#/147"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Automated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/149"
+ },
+ {
+ "$ref": "#/150"
},
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2024-08-08-preview",
+ "name": "Microsoft.DesktopVirtualization/hostPools@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/110"
+ "$ref": "#/69"
},
"flags": 0
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules"
+ "value": "Microsoft.DesktopVirtualization/scalingPlans"
},
{
"$type": "StringLiteralType",
@@ -1861,7 +2103,7 @@
},
{
"$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans",
"properties": {
"id": {
"type": {
@@ -1872,226 +2114,310 @@
},
"name": {
"type": {
- "$ref": "#/107"
+ "$ref": "#/39"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/137"
+ "$ref": "#/154"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/138"
+ "$ref": "#/155"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/140"
+ "$ref": "#/157"
},
"flags": 1,
- "description": "Detailed properties for ScalingPlanPersonalSchedule"
+ "description": "Detailed properties for scaling plan."
},
- "systemData": {
+ "identity": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/47"
+ },
+ "flags": 0,
+ "description": "The managed service identities assigned to this resource."
+ },
+ "etag": {
+ "type": {
+ "$ref": "#/2"
},
"flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
- }
- }
- },
+ "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ },
+ "kind": {
+ "type": {
+ "$ref": "#/56"
+ },
+ "flags": 0,
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ },
+ "managedBy": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
+ },
+ "plan": {
+ "type": {
+ "$ref": "#/57"
+ },
+ "flags": 0,
+ "description": "Details of the resource plan."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/58"
+ },
+ "flags": 0,
+ "description": "The SKU (Stock Keeping Unit) assigned to this resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/194"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
{
"$type": "ObjectType",
- "name": "ScalingPlanPersonalScheduleProperties",
+ "name": "ScalingPlanProperties",
"properties": {
- "daysOfWeek": {
+ "objectId": {
"type": {
- "$ref": "#/149"
+ "$ref": "#/2"
},
- "flags": 1,
- "description": "Set of days of the week on which this schedule is active."
+ "flags": 2,
+ "description": "ObjectId of scaling plan. (internal use)"
},
- "rampUpStartTime": {
+ "description": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/2"
},
- "flags": 1,
- "description": "Starting time for ramp up period."
+ "flags": 0,
+ "description": "Description of scaling plan."
},
- "rampUpAutoStartHosts": {
+ "friendlyName": {
"type": {
- "$ref": "#/153"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool."
+ "description": "User friendly name of scaling plan."
},
- "rampUpStartVMOnConnect": {
+ "timeZone": {
"type": {
- "$ref": "#/156"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually."
+ "flags": 1,
+ "description": "Timezone of the scaling plan."
},
- "rampUpActionOnDisconnect": {
+ "hostPoolType": {
"type": {
"$ref": "#/160"
},
"flags": 0,
- "description": "Action to be taken after a user disconnect during the ramp up period."
+ "description": "HostPool type for desktop."
},
- "rampUpMinutesToWaitOnDisconnect": {
+ "exclusionTag": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period."
+ "description": "Exclusion tag for scaling plan."
},
- "rampUpActionOnLogoff": {
+ "schedules": {
"type": {
- "$ref": "#/165"
+ "$ref": "#/191"
},
"flags": 0,
- "description": "Action to be taken after a logoff during the ramp up period."
+ "description": "List of ScalingPlanPooledSchedule definitions."
},
- "rampUpMinutesToWaitOnLogoff": {
+ "hostPoolReferences": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/193"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period."
+ "description": "List of ScalingHostPoolReference definitions."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Pooled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Personal"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/158"
},
- "peakStartTime": {
+ {
+ "$ref": "#/159"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScalingSchedule",
+ "properties": {
+ "name": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/2"
},
- "flags": 1,
- "description": "Starting time for peak period."
+ "flags": 0,
+ "description": "Name of the ScalingPlanPooledSchedule."
},
- "peakStartVMOnConnect": {
+ "daysOfWeek": {
"type": {
- "$ref": "#/168"
+ "$ref": "#/170"
},
"flags": 0,
- "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase."
+ "description": "Set of days of the week on which this schedule is active."
},
- "peakActionOnDisconnect": {
+ "rampUpStartTime": {
"type": {
- "$ref": "#/172"
+ "$ref": "#/171"
},
"flags": 0,
- "description": "Action to be taken after a user disconnect during the peak period."
+ "description": "Starting time for ramp up period."
},
- "peakMinutesToWaitOnDisconnect": {
+ "rampUpLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/176"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period."
+ "description": "Load balancing algorithm for ramp up period."
},
- "peakActionOnLogoff": {
+ "rampUpMinimumHostsPct": {
"type": {
- "$ref": "#/176"
+ "$ref": "#/177"
},
"flags": 0,
- "description": "Action to be taken after a logoff during the peak period."
+ "description": "Minimum host percentage for ramp up period."
},
- "peakMinutesToWaitOnLogoff": {
+ "rampUpCapacityThresholdPct": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/178"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period."
+ "description": "Capacity threshold for ramp up period."
},
- "rampDownStartTime": {
+ "peakStartTime": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/171"
},
- "flags": 1,
- "description": "Starting time for ramp down period."
+ "flags": 0,
+ "description": "Starting time for peak period."
},
- "rampDownStartVMOnConnect": {
+ "peakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/179"
+ "$ref": "#/181"
},
"flags": 0,
- "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase."
+ "description": "Load balancing algorithm for peak period."
},
- "rampDownActionOnDisconnect": {
+ "rampDownStartTime": {
"type": {
- "$ref": "#/183"
+ "$ref": "#/171"
},
"flags": 0,
- "description": "Action to be taken after a user disconnect during the ramp down period."
+ "description": "Starting time for ramp down period."
},
- "rampDownMinutesToWaitOnDisconnect": {
+ "rampDownLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/184"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period."
+ "description": "Load balancing algorithm for ramp down period."
},
- "rampDownActionOnLogoff": {
+ "rampDownMinimumHostsPct": {
"type": {
- "$ref": "#/187"
+ "$ref": "#/177"
},
"flags": 0,
- "description": "Action to be taken after a logoff during the ramp down period."
+ "description": "Minimum host percentage for ramp down period."
},
- "rampDownMinutesToWaitOnLogoff": {
+ "rampDownCapacityThresholdPct": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/178"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period."
+ "description": "Capacity threshold for ramp down period."
},
- "offPeakStartTime": {
+ "rampDownForceLogoffUsers": {
"type": {
- "$ref": "#/82"
+ "$ref": "#/12"
},
- "flags": 1,
- "description": "Starting time for off-peak period."
+ "flags": 0,
+ "description": "Should users be logged off forcefully from hosts."
},
- "offPeakStartVMOnConnect": {
+ "rampDownStopHostsWhen": {
"type": {
- "$ref": "#/190"
+ "$ref": "#/187"
},
"flags": 0,
- "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase."
+ "description": "Specifies when to stop hosts during ramp down period."
},
- "offPeakActionOnDisconnect": {
+ "rampDownWaitTimeMinutes": {
"type": {
- "$ref": "#/194"
+ "$ref": "#/64"
},
"flags": 0,
- "description": "Action to be taken after a user disconnect during the off-peak period."
+ "description": "Number of minutes to wait to stop hosts during ramp down period."
},
- "offPeakMinutesToWaitOnDisconnect": {
+ "rampDownNotificationMessage": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period."
+ "description": "Notification message for users during ramp down period."
},
- "offPeakActionOnLogoff": {
+ "offPeakStartTime": {
"type": {
- "$ref": "#/198"
+ "$ref": "#/171"
},
"flags": 0,
- "description": "Action to be taken after a logoff during the off-peak period."
+ "description": "Starting time for off-peak period."
},
- "offPeakMinutesToWaitOnLogoff": {
+ "offPeakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/161"
+ "$ref": "#/190"
},
"flags": 0,
- "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period."
+ "description": "Load balancing algorithm for off-peak period."
}
}
},
@@ -2127,57 +2453,80 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/141"
+ "$ref": "#/162"
},
{
- "$ref": "#/142"
+ "$ref": "#/163"
},
{
- "$ref": "#/143"
+ "$ref": "#/164"
},
{
- "$ref": "#/144"
+ "$ref": "#/165"
},
{
- "$ref": "#/145"
+ "$ref": "#/166"
},
{
- "$ref": "#/146"
+ "$ref": "#/167"
},
{
- "$ref": "#/147"
+ "$ref": "#/168"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/148"
+ "$ref": "#/169"
}
},
{
- "$type": "StringLiteralType",
- "value": "None"
+ "$type": "ObjectType",
+ "name": "Time",
+ "properties": {
+ "hour": {
+ "type": {
+ "$ref": "#/172"
+ },
+ "flags": 1,
+ "description": "The hour."
+ },
+ "minute": {
+ "type": {
+ "$ref": "#/173"
+ },
+ "flags": 1,
+ "description": "The minute."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 23
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 59
},
{
"$type": "StringLiteralType",
- "value": "WithAssignedUser"
+ "value": "BreadthFirst"
},
{
"$type": "StringLiteralType",
- "value": "All"
+ "value": "DepthFirst"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/150"
- },
- {
- "$ref": "#/151"
+ "$ref": "#/174"
},
{
- "$ref": "#/152"
+ "$ref": "#/175"
},
{
"$ref": "#/2"
@@ -2185,83 +2534,53 @@
]
},
{
- "$type": "StringLiteralType",
- "value": "Enable"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disable"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/154"
- },
- {
- "$ref": "#/155"
- },
- {
- "$ref": "#/2"
- }
- ]
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 100
},
{
- "$type": "StringLiteralType",
- "value": "None"
+ "$type": "IntegerType",
+ "minValue": 1,
+ "maxValue": 100
},
{
"$type": "StringLiteralType",
- "value": "Deallocate"
+ "value": "BreadthFirst"
},
{
"$type": "StringLiteralType",
- "value": "Hibernate"
+ "value": "DepthFirst"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/157"
- },
- {
- "$ref": "#/158"
+ "$ref": "#/179"
},
{
- "$ref": "#/159"
+ "$ref": "#/180"
},
{
"$ref": "#/2"
}
]
},
- {
- "$type": "IntegerType",
- "minValue": 0
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
- },
{
"$type": "StringLiteralType",
- "value": "Deallocate"
+ "value": "BreadthFirst"
},
{
"$type": "StringLiteralType",
- "value": "Hibernate"
+ "value": "DepthFirst"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/162"
- },
- {
- "$ref": "#/163"
+ "$ref": "#/182"
},
{
- "$ref": "#/164"
+ "$ref": "#/183"
},
{
"$ref": "#/2"
@@ -2270,20 +2589,20 @@
},
{
"$type": "StringLiteralType",
- "value": "Enable"
+ "value": "ZeroSessions"
},
{
"$type": "StringLiteralType",
- "value": "Disable"
+ "value": "ZeroActiveSessions"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/166"
+ "$ref": "#/185"
},
{
- "$ref": "#/167"
+ "$ref": "#/186"
},
{
"$ref": "#/2"
@@ -2292,27 +2611,20 @@
},
{
"$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "Deallocate"
+ "value": "BreadthFirst"
},
{
"$type": "StringLiteralType",
- "value": "Hibernate"
+ "value": "DepthFirst"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/169"
- },
- {
- "$ref": "#/170"
+ "$ref": "#/188"
},
{
- "$ref": "#/171"
+ "$ref": "#/189"
},
{
"$ref": "#/2"
@@ -2320,249 +2632,121 @@
]
},
{
- "$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "Deallocate"
- },
- {
- "$type": "StringLiteralType",
- "value": "Hibernate"
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/161"
+ }
},
{
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/173"
- },
- {
- "$ref": "#/174"
- },
- {
- "$ref": "#/175"
+ "$type": "ObjectType",
+ "name": "ScalingHostPoolReference",
+ "properties": {
+ "hostPoolArmPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Arm path of referenced hostpool."
},
- {
- "$ref": "#/2"
+ "scalingPlanEnabled": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Is the scaling plan enabled for this hostpool."
}
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Enable"
+ }
},
{
- "$type": "StringLiteralType",
- "value": "Disable"
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/192"
+ }
},
{
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/177"
- },
- {
- "$ref": "#/178"
- },
- {
- "$ref": "#/2"
- }
- ]
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
},
{
- "$type": "StringLiteralType",
- "value": "None"
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/156"
+ },
+ "flags": 0
},
{
"$type": "StringLiteralType",
- "value": "Deallocate"
+ "value": "Microsoft.DesktopVirtualization/workspaces"
},
{
"$type": "StringLiteralType",
- "value": "Hibernate"
+ "value": "2024-08-08-preview"
},
{
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/180"
+ "$type": "ObjectType",
+ "name": "Microsoft.DesktopVirtualization/workspaces",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
},
- {
- "$ref": "#/181"
+ "name": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 9,
+ "description": "The resource name"
},
- {
- "$ref": "#/182"
+ "type": {
+ "type": {
+ "$ref": "#/196"
+ },
+ "flags": 10,
+ "description": "The resource type"
},
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "Deallocate"
- },
- {
- "$type": "StringLiteralType",
- "value": "Hibernate"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/184"
+ "apiVersion": {
+ "type": {
+ "$ref": "#/197"
+ },
+ "flags": 10,
+ "description": "The resource api version"
},
- {
- "$ref": "#/185"
+ "properties": {
+ "type": {
+ "$ref": "#/199"
+ },
+ "flags": 0,
+ "description": "Detailed properties for Workspace"
},
- {
- "$ref": "#/186"
+ "identity": {
+ "type": {
+ "$ref": "#/47"
+ },
+ "flags": 0,
+ "description": "The managed service identities assigned to this resource."
},
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Enable"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disable"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/188"
+ "etag": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- {
- "$ref": "#/189"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "Deallocate"
- },
- {
- "$type": "StringLiteralType",
- "value": "Hibernate"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/191"
- },
- {
- "$ref": "#/192"
- },
- {
- "$ref": "#/193"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "Deallocate"
- },
- {
- "$type": "StringLiteralType",
- "value": "Hibernate"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/195"
- },
- {
- "$ref": "#/196"
- },
- {
- "$ref": "#/197"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/139"
- },
- "flags": 0
- },
- {
- "$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/applicationGroups"
- },
- {
- "$type": "StringLiteralType",
- "value": "2024-08-08-preview"
- },
- {
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/applicationGroups",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
- "name": {
- "type": {
- "$ref": "#/0"
- },
- "flags": 9,
- "description": "The resource name"
- },
- "type": {
- "type": {
- "$ref": "#/200"
- },
- "flags": 10,
- "description": "The resource type"
- },
- "apiVersion": {
- "type": {
- "$ref": "#/201"
- },
- "flags": 10,
- "description": "The resource api version"
- },
- "properties": {
- "type": {
- "$ref": "#/203"
- },
- "flags": 1,
- "description": "Detailed properties for ApplicationGroup"
+ "kind": {
+ "type": {
+ "$ref": "#/56"
+ },
+ "flags": 0,
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
"managedBy": {
"type": {
@@ -2571,44 +2755,23 @@
"flags": 0,
"description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
},
- "kind": {
- "type": {
- "$ref": "#/37"
- },
- "flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
- },
- "etag": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 2,
- "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
- },
- "identity": {
+ "plan": {
"type": {
- "$ref": "#/38"
+ "$ref": "#/57"
},
"flags": 0,
- "description": "Managed service identity (system assigned and/or user assigned identities)"
+ "description": "Details of the resource plan."
},
"sku": {
"type": {
- "$ref": "#/47"
- },
- "flags": 0,
- "description": "The resource model definition representing SKU"
- },
- "plan": {
- "type": {
- "$ref": "#/54"
+ "$ref": "#/58"
},
"flags": 0,
- "description": "Plan for the resource."
+ "description": "The SKU (Stock Keeping Unit) assigned to this resource."
},
"tags": {
"type": {
- "$ref": "#/207"
+ "$ref": "#/205"
},
"flags": 0,
"description": "Resource tags."
@@ -2622,7 +2785,7 @@
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -2631,88 +2794,93 @@
},
{
"$type": "ObjectType",
- "name": "ApplicationGroupProperties",
+ "name": "WorkspaceProperties",
"properties": {
"objectId": {
"type": {
"$ref": "#/2"
},
"flags": 2,
- "description": "ObjectId of ApplicationGroup. (internal use)"
+ "description": "ObjectId of Workspace. (internal use)"
},
"description": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Description of ApplicationGroup."
+ "description": "Description of Workspace."
},
"friendlyName": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Friendly name of ApplicationGroup."
+ "description": "Friendly name of Workspace."
},
- "hostPoolArmPath": {
+ "applicationGroupReferences": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/200"
},
- "flags": 1,
- "description": "HostPool arm path of ApplicationGroup."
+ "flags": 0,
+ "description": "List of applicationGroup resource Ids."
},
- "workspaceArmPath": {
+ "cloudPcResource": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/12"
},
"flags": 2,
- "description": "Workspace arm path of ApplicationGroup."
+ "description": "Is cloud pc resource."
},
- "applicationGroupType": {
+ "publicNetworkAccess": {
"type": {
- "$ref": "#/206"
+ "$ref": "#/203"
},
- "flags": 1,
- "description": "Resource Type of ApplicationGroup."
+ "flags": 0,
+ "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints"
},
- "cloudPcResource": {
+ "privateEndpointConnections": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/204"
},
"flags": 2,
- "description": "Is cloud pc resource."
- },
- "showInFeed": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Boolean representing whether the applicationGroup is show in the feed."
+ "description": "List of private endpoint connection associated with the specified resource"
}
}
},
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
{
"$type": "StringLiteralType",
- "value": "RemoteApp"
+ "value": "Enabled"
},
{
"$type": "StringLiteralType",
- "value": "Desktop"
+ "value": "Disabled"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/204"
+ "$ref": "#/201"
},
{
- "$ref": "#/205"
+ "$ref": "#/202"
},
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/118"
+ }
+ },
{
"$type": "ObjectType",
"name": "TrackedResourceTags",
@@ -2723,10 +2891,10 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/applicationGroups@2024-08-08-preview",
+ "name": "Microsoft.DesktopVirtualization/workspaces@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/202"
+ "$ref": "#/198"
},
"flags": 0
},
@@ -2757,35 +2925,35 @@
},
"name": {
"type": {
- "$ref": "#/209"
+ "$ref": "#/207"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/210"
+ "$ref": "#/208"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/211"
+ "$ref": "#/209"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/213"
+ "$ref": "#/211"
},
"flags": 1,
"description": "Detailed properties for Application"
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -2840,14 +3008,14 @@
},
"applicationType": {
"type": {
- "$ref": "#/216"
+ "$ref": "#/214"
},
"flags": 0,
"description": "Resource Type of Application."
},
"commandLineSetting": {
"type": {
- "$ref": "#/220"
+ "$ref": "#/218"
},
"flags": 1,
"description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all."
@@ -2861,7 +3029,7 @@
},
"showInPortal": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Specifies whether to show the RemoteApp program in the RD Web Access server."
@@ -2875,7 +3043,7 @@
},
"iconIndex": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/64"
},
"flags": 0,
"description": "Index of the icon."
@@ -2889,7 +3057,7 @@
},
"iconContent": {
"type": {
- "$ref": "#/221"
+ "$ref": "#/16"
},
"flags": 2,
"description": "the icon a 64 bit string as a byte array."
@@ -2908,10 +3076,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/214"
+ "$ref": "#/212"
},
{
- "$ref": "#/215"
+ "$ref": "#/213"
},
{
"$ref": "#/2"
@@ -2934,34 +3102,37 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/217"
+ "$ref": "#/215"
},
{
- "$ref": "#/218"
+ "$ref": "#/216"
},
{
- "$ref": "#/219"
+ "$ref": "#/217"
},
{
"$ref": "#/2"
}
]
},
- {
- "$type": "AnyType"
- },
{
"$type": "ResourceType",
"name": "Microsoft.DesktopVirtualization/applicationGroups/applications@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/212"
+ "$ref": "#/210"
},
"flags": 0
},
+ {
+ "$type": "StringType",
+ "minLength": 3,
+ "maxLength": 100,
+ "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
+ },
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools"
+ "value": "Microsoft.DesktopVirtualization/hostPools/msixPackages"
},
{
"$type": "StringLiteralType",
@@ -2969,7 +3140,7 @@
},
{
"$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools",
+ "name": "Microsoft.DesktopVirtualization/hostPools/msixPackages",
"properties": {
"id": {
"type": {
@@ -2980,329 +3151,494 @@
},
"name": {
"type": {
- "$ref": "#/0"
+ "$ref": "#/220"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/223"
+ "$ref": "#/221"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/224"
+ "$ref": "#/222"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/226"
+ "$ref": "#/224"
},
"flags": 1,
- "description": "Detailed properties for HostPool"
+ "description": "Detailed properties for MSIX Package"
},
- "managedBy": {
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MsixPackageProperties",
+ "properties": {
+ "imagePath": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
+ "description": "VHD/CIM image path on Network Share."
},
- "kind": {
+ "packageName": {
"type": {
- "$ref": "#/37"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ "description": "Package Name from appxmanifest.xml."
},
- "etag": {
+ "packageFamilyName": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
+ "flags": 0,
+ "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name."
},
- "identity": {
+ "displayName": {
"type": {
- "$ref": "#/38"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Managed service identity (system assigned and/or user assigned identities)"
+ "description": "User friendly Name to be displayed in the portal."
},
- "sku": {
+ "packageRelativePath": {
"type": {
- "$ref": "#/47"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "The resource model definition representing SKU"
+ "description": "Relative Path to the package inside the image."
},
- "plan": {
+ "isRegularRegistration": {
"type": {
- "$ref": "#/54"
+ "$ref": "#/12"
},
"flags": 0,
- "description": "Plan for the resource."
+ "description": "Specifies how to register Package in feed."
},
- "tags": {
+ "isActive": {
"type": {
- "$ref": "#/294"
+ "$ref": "#/12"
},
"flags": 0,
- "description": "Resource tags."
+ "description": "Make this version of the package the active one across the hostpool."
},
- "location": {
+ "packageDependencies": {
+ "type": {
+ "$ref": "#/225"
+ },
+ "flags": 0,
+ "description": "List of package dependencies."
+ },
+ "version": {
"type": {
"$ref": "#/2"
},
- "flags": 1,
- "description": "The geo-location where the resource lives"
+ "flags": 0,
+ "description": "Package version found in the appxmanifest.xml."
},
- "systemData": {
+ "lastUpdated": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ "flags": 0,
+ "description": "Date Package was last updated, found in the appxmanifest.xml."
+ },
+ "packageApplications": {
+ "type": {
+ "$ref": "#/226"
+ },
+ "flags": 0,
+ "description": "List of package applications."
}
}
},
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/13"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/15"
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/msixPackages@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/223"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-08-08-preview"
+ },
{
"$type": "ObjectType",
- "name": "HostPoolProperties",
+ "name": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections",
"properties": {
- "objectId": {
+ "id": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "ObjectId of HostPool. (internal use)"
+ "flags": 10,
+ "description": "The resource id"
},
- "friendlyName": {
+ "name": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "Friendly name of HostPool."
+ "flags": 9,
+ "description": "The resource name"
},
- "description": {
+ "type": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/228"
},
- "flags": 0,
- "description": "Description of HostPool."
+ "flags": 10,
+ "description": "The resource type"
},
- "hostPoolType": {
+ "apiVersion": {
"type": {
- "$ref": "#/230"
+ "$ref": "#/229"
},
- "flags": 1,
- "description": "HostPool type for desktop."
+ "flags": 10,
+ "description": "The resource api version"
},
- "personalDesktopAssignmentType": {
+ "properties": {
"type": {
- "$ref": "#/233"
+ "$ref": "#/119"
},
"flags": 0,
- "description": "PersonalDesktopAssignment type for HostPool."
+ "description": "The resource-specific properties for this resource."
},
- "customRdpProperty": {
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/230"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-08-08-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections",
+ "properties": {
+ "id": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "Custom rdp property of HostPool."
+ "flags": 10,
+ "description": "The resource id"
},
- "maxSessionLimit": {
+ "name": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "The max session limit of HostPool."
+ "flags": 9,
+ "description": "The resource name"
},
- "loadBalancerType": {
+ "type": {
"type": {
- "$ref": "#/238"
+ "$ref": "#/232"
},
- "flags": 1,
- "description": "The type of the load balancer."
+ "flags": 10,
+ "description": "The resource type"
},
- "ring": {
+ "apiVersion": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/233"
},
- "flags": 0,
- "description": "The ring number of HostPool."
+ "flags": 10,
+ "description": "The resource api version"
},
- "validationEnvironment": {
+ "properties": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/119"
},
"flags": 0,
- "description": "Is validation environment."
+ "description": "The resource-specific properties for this resource."
},
- "registrationInfo": {
+ "systemData": {
"type": {
- "$ref": "#/239"
+ "$ref": "#/27"
},
- "flags": 0,
- "description": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
- },
- "vmTemplate": {
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/234"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-08-08-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations",
+ "properties": {
+ "id": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "VM template for sessionhosts configuration within hostpool."
+ "flags": 10,
+ "description": "The resource id"
},
- "managementType": {
+ "name": {
"type": {
- "$ref": "#/246"
+ "$ref": "#/236"
},
- "flags": 0,
- "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated."
+ "flags": 9,
+ "description": "The resource name"
},
- "applicationGroupReferences": {
+ "type": {
"type": {
- "$ref": "#/247"
+ "$ref": "#/237"
},
- "flags": 2,
- "description": "List of applicationGroup links."
+ "flags": 10,
+ "description": "The resource type"
},
- "appAttachPackageReferences": {
+ "apiVersion": {
"type": {
- "$ref": "#/248"
+ "$ref": "#/238"
},
- "flags": 2,
- "description": "List of App Attach Package links."
+ "flags": 10,
+ "description": "The resource api version"
},
- "ssoadfsAuthority": {
+ "properties": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/240"
},
- "flags": 0,
- "description": "URL to customer ADFS server for signing WVD SSO certificates."
+ "flags": 1,
+ "description": "Detailed properties for SessionHostConfiguration"
},
- "ssoClientId": {
+ "systemData": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/27"
},
- "flags": 0,
- "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates."
- },
- "ssoClientSecretKeyVaultPath": {
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SessionHostConfigurationProperties",
+ "properties": {
+ "version": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "Path to Azure KeyVault storing the secret used for communication to ADFS."
+ "flags": 2,
+ "description": "The timestamp of the last update."
},
- "ssoSecretType": {
+ "friendlyName": {
"type": {
- "$ref": "#/253"
+ "$ref": "#/241"
},
"flags": 0,
- "description": "The type of single sign on Secret Type."
+ "description": "Friendly name to describe this version of the SessionHostConfiguration."
},
- "preferredAppGroupType": {
+ "provisioningState": {
"type": {
- "$ref": "#/257"
+ "$ref": "#/246"
},
- "flags": 1,
- "description": "The type of preferred application group type, default to Desktop Application Group"
+ "flags": 2,
+ "description": "Provisioning state of the Session Host Configuration."
},
- "startVMOnConnect": {
+ "vmTags": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/247"
},
"flags": 0,
- "description": "The flag to turn on/off StartVMOnConnect feature."
+ "description": "Hashtable that lists key/value pair tags to apply to the VMs"
},
- "cloudPcResource": {
+ "vmLocation": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/2"
},
- "flags": 2,
- "description": "Is cloud pc resource."
+ "flags": 0,
+ "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided"
},
- "publicNetworkAccess": {
+ "vmResourceGroup": {
"type": {
- "$ref": "#/262"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints"
+ "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided."
},
- "agentUpdate": {
+ "vmNamePrefix": {
"type": {
- "$ref": "#/263"
+ "$ref": "#/248"
+ },
+ "flags": 1,
+ "description": "The prefix that should be associated with session host names"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/249"
},
"flags": 0,
- "description": "The session host configuration for updating agent, monitoring agent, and stack component."
+ "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]."
},
- "privateEndpointConnections": {
+ "networkInfo": {
"type": {
- "$ref": "#/277"
+ "$ref": "#/250"
},
- "flags": 2,
- "description": "List of private endpoint connection associated with the specified resource"
+ "flags": 1,
+ "description": "Network information."
},
- "managedPrivateUDP": {
+ "vmSizeId": {
"type": {
- "$ref": "#/281"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ "flags": 1,
+ "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6"
},
- "directUDP": {
+ "diskInfo": {
"type": {
- "$ref": "#/285"
+ "$ref": "#/251"
+ },
+ "flags": 1,
+ "description": "Disk Information"
+ },
+ "customConfigurationScriptUrl": {
+ "type": {
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning."
},
- "publicUDP": {
+ "imageInfo": {
+ "type": {
+ "$ref": "#/256"
+ },
+ "flags": 1,
+ "description": "Image configurations of HostPool."
+ },
+ "domainInfo": {
+ "type": {
+ "$ref": "#/262"
+ },
+ "flags": 1,
+ "description": "Domain configurations of session hosts."
+ },
+ "securityInfo": {
"type": {
- "$ref": "#/289"
+ "$ref": "#/269"
},
"flags": 0,
- "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ "description": "Security Information"
},
- "relayUDP": {
+ "vmAdminCredentials": {
+ "type": {
+ "$ref": "#/267"
+ },
+ "flags": 1,
+ "description": "Local Admin credentials for session hosts.\""
+ },
+ "bootDiagnosticsInfo": {
"type": {
- "$ref": "#/293"
+ "$ref": "#/274"
},
"flags": 0,
- "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ "description": "Boot Diagnostics Information"
}
}
},
+ {
+ "$type": "StringType",
+ "maxLength": 260
+ },
{
"$type": "StringLiteralType",
- "value": "Personal"
+ "value": "Succeeded"
},
{
"$type": "StringLiteralType",
- "value": "Pooled"
+ "value": "Failed"
},
{
"$type": "StringLiteralType",
- "value": "BYODesktop"
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/227"
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/243"
},
{
- "$ref": "#/228"
+ "$ref": "#/244"
},
{
- "$ref": "#/229"
+ "$ref": "#/245"
},
{
"$ref": "#/2"
@@ -3310,57 +3646,79 @@
]
},
{
- "$type": "StringLiteralType",
- "value": "Automatic"
+ "$type": "ObjectType",
+ "name": "SessionHostConfigurationPropertiesVmTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
},
{
- "$type": "StringLiteralType",
- "value": "Direct"
+ "$type": "StringType",
+ "maxLength": 11
},
{
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/231"
- },
- {
- "$ref": "#/232"
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/64"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkInfoProperties",
+ "properties": {
+ "subnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of the subnet."
},
- {
- "$ref": "#/2"
+ "securityGroupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)."
}
- ]
+ }
},
{
- "$type": "StringLiteralType",
- "value": "BreadthFirst"
+ "$type": "ObjectType",
+ "name": "DiskInfoProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 1,
+ "description": "The disk type used by virtual machine in hostpool session host."
+ }
+ }
},
{
"$type": "StringLiteralType",
- "value": "DepthFirst"
+ "value": "Standard_LRS"
},
{
"$type": "StringLiteralType",
- "value": "Persistent"
+ "value": "Premium_LRS"
},
{
"$type": "StringLiteralType",
- "value": "MultiplePersistent"
+ "value": "StandardSSD_LRS"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/234"
- },
- {
- "$ref": "#/235"
+ "$ref": "#/252"
},
{
- "$ref": "#/236"
+ "$ref": "#/253"
},
{
- "$ref": "#/237"
+ "$ref": "#/254"
},
{
"$ref": "#/2"
@@ -3369,54 +3727,47 @@
},
{
"$type": "ObjectType",
- "name": "RegistrationInfo",
+ "name": "ImageInfoProperties",
"properties": {
- "expirationTime": {
+ "type": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/259"
},
- "flags": 0,
- "description": "Expiration time of registration token."
+ "flags": 1,
+ "description": "The type of image session hosts use in the hostpool."
},
- "token": {
+ "marketplaceInfo": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/260"
},
"flags": 0,
- "description": "The registration token base64 encoded string."
+ "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type."
},
- "registrationTokenOperation": {
+ "customInfo": {
"type": {
- "$ref": "#/243"
+ "$ref": "#/261"
},
"flags": 0,
- "description": "The type of resetting the token."
+ "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type."
}
}
},
{
"$type": "StringLiteralType",
- "value": "Delete"
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
+ "value": "Marketplace"
},
{
"$type": "StringLiteralType",
- "value": "Update"
+ "value": "Custom"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/240"
- },
- {
- "$ref": "#/241"
+ "$ref": "#/257"
},
{
- "$ref": "#/242"
+ "$ref": "#/258"
},
{
"$ref": "#/2"
@@ -3424,134 +3775,95 @@
]
},
{
- "$type": "StringLiteralType",
- "value": "Automated"
- },
- {
- "$type": "StringLiteralType",
- "value": "Standard"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/244"
+ "$type": "ObjectType",
+ "name": "MarketplaceInfoProperties",
+ "properties": {
+ "offer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The offer of the image."
},
- {
- "$ref": "#/245"
+ "publisher": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The publisher of the image."
},
- {
- "$ref": "#/2"
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The SKU of the image."
+ },
+ "exactVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The version of the image."
}
- ]
- },
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/2"
}
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/2"
+ "$type": "ObjectType",
+ "name": "CustomInfoProperties",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of the image."
+ }
}
},
{
- "$type": "StringLiteralType",
- "value": "SharedKey"
- },
- {
- "$type": "StringLiteralType",
- "value": "Certificate"
- },
- {
- "$type": "StringLiteralType",
- "value": "SharedKeyInKeyVault"
- },
- {
- "$type": "StringLiteralType",
- "value": "CertificateInKeyVault"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/249"
- },
- {
- "$ref": "#/250"
- },
- {
- "$ref": "#/251"
- },
- {
- "$ref": "#/252"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "None"
- },
- {
- "$type": "StringLiteralType",
- "value": "Desktop"
- },
- {
- "$type": "StringLiteralType",
- "value": "RailApplications"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/254"
- },
- {
- "$ref": "#/255"
+ "$type": "ObjectType",
+ "name": "DomainInfoProperties",
+ "properties": {
+ "joinType": {
+ "type": {
+ "$ref": "#/265"
+ },
+ "flags": 1,
+ "description": "The type of domain join done by the virtual machine."
},
- {
- "$ref": "#/256"
+ "activeDirectoryInfo": {
+ "type": {
+ "$ref": "#/266"
+ },
+ "flags": 0,
+ "description": "Active directory info. Only one should be populated based on the join type."
},
- {
- "$ref": "#/2"
+ "azureActiveDirectoryInfo": {
+ "type": {
+ "$ref": "#/268"
+ },
+ "flags": 0,
+ "description": "Azure active directory info. Only one should be populated based on the join type."
}
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Enabled"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disabled"
+ }
},
{
"$type": "StringLiteralType",
- "value": "EnabledForSessionHostsOnly"
+ "value": "ActiveDirectory"
},
{
"$type": "StringLiteralType",
- "value": "EnabledForClientsOnly"
+ "value": "AzureActiveDirectory"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/258"
- },
- {
- "$ref": "#/259"
- },
- {
- "$ref": "#/260"
+ "$ref": "#/263"
},
{
- "$ref": "#/261"
+ "$ref": "#/264"
},
{
"$ref": "#/2"
@@ -3560,117 +3872,106 @@
},
{
"$type": "ObjectType",
- "name": "AgentUpdateProperties",
+ "name": "ActiveDirectoryInfoProperties",
"properties": {
- "type": {
+ "domainCredentials": {
"type": {
- "$ref": "#/266"
+ "$ref": "#/267"
},
- "flags": 0,
- "description": "The type of maintenance for session host components."
+ "flags": 1,
+ "description": "Credentials needed to create the virtual machine."
},
- "useSessionHostLocalTime": {
+ "ouPath": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "Whether to use localTime of the virtual machine."
+ "flags": 1,
+ "description": "The organizational unit(OU) path."
},
- "maintenanceWindowTimeZone": {
+ "domainName": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true."
+ "description": "The domain a virtual machine connected to a hostpool will join."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyVaultCredentialsProperties",
+ "properties": {
+ "usernameKeyVaultSecretUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The uri to access the secret that the username is stored in."
},
- "maintenanceWindows": {
+ "passwordKeyVaultSecretUri": {
"type": {
- "$ref": "#/276"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "List of maintenance windows. Maintenance windows are 2 hours long."
+ "flags": 1,
+ "description": "The uri to access the secret that the password is stored in."
}
}
},
{
- "$type": "StringLiteralType",
- "value": "Default"
- },
- {
- "$type": "StringLiteralType",
- "value": "Scheduled"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/264"
- },
- {
- "$ref": "#/265"
- },
- {
- "$ref": "#/2"
+ "$type": "ObjectType",
+ "name": "AzureActiveDirectoryInfoProperties",
+ "properties": {
+ "mdmProviderGuid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The Mobile Device Management(MDM) guid."
}
- ]
+ }
},
{
"$type": "ObjectType",
- "name": "MaintenanceWindowProperties",
+ "name": "SecurityInfoProperties",
"properties": {
- "hour": {
+ "type": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/273"
},
"flags": 0,
- "description": "The update start hour of the day. (0 - 23)"
+ "description": "The security type used by virtual machine in hostpool session host. Default is Standard."
},
- "dayOfWeek": {
+ "secureBootEnabled": {
"type": {
- "$ref": "#/275"
+ "$ref": "#/12"
},
"flags": 0,
- "description": "Day of the week."
+ "description": "Whether to use secureBoot on the virtual machine."
+ },
+ "vTpmEnabled": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Whether to use vTpm on the virtual machine."
}
}
},
{
"$type": "StringLiteralType",
- "value": "Monday"
- },
- {
- "$type": "StringLiteralType",
- "value": "Tuesday"
- },
- {
- "$type": "StringLiteralType",
- "value": "Wednesday"
- },
- {
- "$type": "StringLiteralType",
- "value": "Thursday"
- },
- {
- "$type": "StringLiteralType",
- "value": "Friday"
+ "value": "Standard"
},
{
"$type": "StringLiteralType",
- "value": "Saturday"
+ "value": "TrustedLaunch"
},
{
"$type": "StringLiteralType",
- "value": "Sunday"
+ "value": "ConfidentialVM"
},
{
"$type": "UnionType",
"elements": [
- {
- "$ref": "#/268"
- },
- {
- "$ref": "#/269"
- },
{
"$ref": "#/270"
},
@@ -3681,212 +3982,93 @@
"$ref": "#/272"
},
{
- "$ref": "#/273"
- },
- {
- "$ref": "#/274"
+ "$ref": "#/2"
}
]
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/267"
+ "$type": "ObjectType",
+ "name": "BootDiagnosticsInfoProperties",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Whether boot diagnostics should be enabled on the Virtual Machine."
+ },
+ "storageUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Uri of the storage account to use for placing the console output and screenshot.
If storageUri is not specified while enabling boot diagnostics, managed storage will be used."
+ }
}
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/11"
- }
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/239"
+ },
+ "flags": 0
},
{
"$type": "StringLiteralType",
- "value": "Default"
+ "value": "default"
},
{
"$type": "StringLiteralType",
- "value": "Enabled"
+ "value": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements"
},
{
"$type": "StringLiteralType",
- "value": "Disabled"
+ "value": "2024-08-08-preview"
},
{
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/278"
- },
- {
- "$ref": "#/279"
+ "$type": "ObjectType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
},
- {
- "$ref": "#/280"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Default"
- },
- {
- "$type": "StringLiteralType",
- "value": "Enabled"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disabled"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/282"
- },
- {
- "$ref": "#/283"
- },
- {
- "$ref": "#/284"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Default"
- },
- {
- "$type": "StringLiteralType",
- "value": "Enabled"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disabled"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/286"
- },
- {
- "$ref": "#/287"
- },
- {
- "$ref": "#/288"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Default"
- },
- {
- "$type": "StringLiteralType",
- "value": "Enabled"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disabled"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/290"
- },
- {
- "$ref": "#/291"
- },
- {
- "$ref": "#/292"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "ObjectType",
- "name": "TrackedResourceTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
- }
- },
- {
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/225"
- },
- "flags": 0
- },
- {
- "$type": "StringLiteralType",
- "value": "default"
- },
- {
- "$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements"
- },
- {
- "$type": "StringLiteralType",
- "value": "2024-08-08-preview"
- },
- {
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
- "name": {
- "type": {
- "$ref": "#/296"
- },
- "flags": 9,
- "description": "The resource name"
+ "name": {
+ "type": {
+ "$ref": "#/276"
+ },
+ "flags": 9,
+ "description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/297"
+ "$ref": "#/277"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/298"
+ "$ref": "#/278"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/300"
+ "$ref": "#/280"
},
"flags": 1,
"description": "Detailed properties for SessionHostManagement"
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -3906,7 +4088,7 @@
},
"update": {
"type": {
- "$ref": "#/301"
+ "$ref": "#/281"
},
"flags": 1,
"description": "Parameters for a hostpool update."
@@ -3919,28 +4101,28 @@
"properties": {
"deleteOriginalVm": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Whether not to save original disk. False by default."
},
"maxVmsRemoved": {
"type": {
- "$ref": "#/302"
+ "$ref": "#/282"
},
"flags": 1,
"description": "The maximum number of virtual machines to be removed during hostpool update."
},
"logOffDelayMinutes": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/64"
},
"flags": 1,
"description": "Grace period before logging off users in minutes."
},
"logOffMessage": {
"type": {
- "$ref": "#/303"
+ "$ref": "#/241"
},
"flags": 0,
"description": "Log off message sent to user for logoff. Default value is an empty string."
@@ -3951,26 +4133,24 @@
"$type": "IntegerType",
"minValue": 1
},
- {
- "$type": "StringType",
- "maxLength": 260
- },
{
"$type": "ResourceType",
"name": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/299"
+ "$ref": "#/279"
},
"flags": 0
},
{
- "$type": "StringLiteralType",
- "value": "default"
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 64,
+ "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations"
+ "value": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules"
},
{
"$type": "StringLiteralType",
@@ -3978,7 +4158,7 @@
},
{
"$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules",
"properties": {
"id": {
"type": {
@@ -3989,35 +4169,35 @@
},
"name": {
"type": {
- "$ref": "#/305"
+ "$ref": "#/284"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/306"
+ "$ref": "#/285"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/307"
+ "$ref": "#/286"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/309"
+ "$ref": "#/288"
},
"flags": 1,
- "description": "Detailed properties for SessionHostConfiguration"
+ "description": "Detailed properties for ScalingPlanPersonalSchedule"
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -4026,288 +4206,297 @@
},
{
"$type": "ObjectType",
- "name": "SessionHostConfigurationProperties",
+ "name": "ScalingPlanPersonalScheduleProperties",
"properties": {
- "version": {
+ "daysOfWeek": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/297"
},
- "flags": 2,
- "description": "The timestamp of the last update."
+ "flags": 1,
+ "description": "Set of days of the week on which this schedule is active."
},
- "friendlyName": {
+ "rampUpStartTime": {
"type": {
- "$ref": "#/303"
+ "$ref": "#/171"
},
- "flags": 0,
- "description": "Friendly name to describe this version of the SessionHostConfiguration."
+ "flags": 1,
+ "description": "Starting time for ramp up period."
},
- "provisioningState": {
+ "rampUpAutoStartHosts": {
"type": {
- "$ref": "#/314"
+ "$ref": "#/301"
},
- "flags": 2,
- "description": "Provisioning state of the Session Host Configuration."
+ "flags": 0,
+ "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool."
},
- "vmTags": {
+ "rampUpStartVMOnConnect": {
"type": {
- "$ref": "#/315"
+ "$ref": "#/304"
},
"flags": 0,
- "description": "Hashtable that lists key/value pair tags to apply to the VMs"
+ "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually."
},
- "vmLocation": {
+ "rampUpActionOnDisconnect": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/308"
},
"flags": 0,
- "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
+ "description": "Action to be taken after a user disconnect during the ramp up period."
},
- "vmResourceGroup": {
+ "rampUpMinutesToWaitOnDisconnect": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/309"
},
"flags": 0,
- "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided."
+ "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period."
},
- "vmNamePrefix": {
+ "rampUpActionOnLogoff": {
"type": {
- "$ref": "#/316"
+ "$ref": "#/313"
},
- "flags": 1,
- "description": "The prefix that should be associated with session host names"
+ "flags": 0,
+ "description": "Action to be taken after a logoff during the ramp up period."
},
- "availabilityZones": {
+ "rampUpMinutesToWaitOnLogoff": {
"type": {
- "$ref": "#/317"
+ "$ref": "#/309"
},
"flags": 0,
- "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]."
+ "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period."
},
- "networkInfo": {
+ "peakStartTime": {
"type": {
- "$ref": "#/318"
+ "$ref": "#/171"
},
"flags": 1,
- "description": "Network information."
+ "description": "Starting time for peak period."
},
- "vmSizeId": {
+ "peakStartVMOnConnect": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/316"
},
- "flags": 1,
- "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6"
+ "flags": 0,
+ "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase."
},
- "diskInfo": {
+ "peakActionOnDisconnect": {
"type": {
- "$ref": "#/319"
+ "$ref": "#/320"
},
- "flags": 1,
- "description": "Disk information."
+ "flags": 0,
+ "description": "Action to be taken after a user disconnect during the peak period."
},
- "customConfigurationScriptUrl": {
+ "peakMinutesToWaitOnDisconnect": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/309"
},
"flags": 0,
- "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning."
+ "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period."
},
- "imageInfo": {
+ "peakActionOnLogoff": {
"type": {
"$ref": "#/324"
},
- "flags": 1,
- "description": "Image configurations of HostPool."
+ "flags": 0,
+ "description": "Action to be taken after a logoff during the peak period."
},
- "domainInfo": {
+ "peakMinutesToWaitOnLogoff": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period."
+ },
+ "rampDownStartTime": {
"type": {
- "$ref": "#/330"
+ "$ref": "#/171"
},
"flags": 1,
- "description": "Domain configurations of session hosts."
+ "description": "Starting time for ramp down period."
},
- "securityInfo": {
+ "rampDownStartVMOnConnect": {
"type": {
- "$ref": "#/337"
+ "$ref": "#/327"
},
"flags": 0,
- "description": "Security information."
+ "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase."
},
- "vmAdminCredentials": {
+ "rampDownActionOnDisconnect": {
"type": {
- "$ref": "#/335"
+ "$ref": "#/331"
+ },
+ "flags": 0,
+ "description": "Action to be taken after a user disconnect during the ramp down period."
+ },
+ "rampDownMinutesToWaitOnDisconnect": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period."
+ },
+ "rampDownActionOnLogoff": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 0,
+ "description": "Action to be taken after a logoff during the ramp down period."
+ },
+ "rampDownMinutesToWaitOnLogoff": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period."
+ },
+ "offPeakStartTime": {
+ "type": {
+ "$ref": "#/171"
},
"flags": 1,
- "description": "Local Admin credentials for session hosts."
+ "description": "Starting time for off-peak period."
},
- "bootDiagnosticsInfo": {
+ "offPeakStartVMOnConnect": {
+ "type": {
+ "$ref": "#/338"
+ },
+ "flags": 0,
+ "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase."
+ },
+ "offPeakActionOnDisconnect": {
"type": {
"$ref": "#/342"
},
"flags": 0,
- "description": "Boot Diagnostics information."
+ "description": "Action to be taken after a user disconnect during the off-peak period."
+ },
+ "offPeakMinutesToWaitOnDisconnect": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period."
+ },
+ "offPeakActionOnLogoff": {
+ "type": {
+ "$ref": "#/346"
+ },
+ "flags": 0,
+ "description": "Action to be taken after a logoff during the off-peak period."
+ },
+ "offPeakMinutesToWaitOnLogoff": {
+ "type": {
+ "$ref": "#/309"
+ },
+ "flags": 0,
+ "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period."
}
}
},
{
"$type": "StringLiteralType",
- "value": "Succeeded"
+ "value": "Monday"
},
{
"$type": "StringLiteralType",
- "value": "Failed"
+ "value": "Tuesday"
},
{
"$type": "StringLiteralType",
- "value": "Canceled"
+ "value": "Wednesday"
},
{
"$type": "StringLiteralType",
- "value": "Provisioning"
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/310"
+ "$ref": "#/289"
},
{
- "$ref": "#/311"
+ "$ref": "#/290"
},
{
- "$ref": "#/312"
+ "$ref": "#/291"
},
{
- "$ref": "#/313"
+ "$ref": "#/292"
},
{
- "$ref": "#/2"
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
}
]
},
- {
- "$type": "ObjectType",
- "name": "SessionHostConfigurationPropertiesVmTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
- }
- },
- {
- "$type": "StringType",
- "maxLength": 11
- },
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/53"
- }
- },
- {
- "$type": "ObjectType",
- "name": "NetworkInfoProperties",
- "properties": {
- "subnetId": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The resource ID of the subnet."
- },
- "securityGroupId": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "DiskInfoProperties",
- "properties": {
- "type": {
- "type": {
- "$ref": "#/323"
- },
- "flags": 1,
- "description": "The disk type used by virtual machine in hostpool session host."
- }
+ "$ref": "#/296"
}
},
{
"$type": "StringLiteralType",
- "value": "Standard_LRS"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "Premium_LRS"
+ "value": "WithAssignedUser"
},
{
"$type": "StringLiteralType",
- "value": "StandardSSD_LRS"
+ "value": "All"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/320"
+ "$ref": "#/298"
},
{
- "$ref": "#/321"
+ "$ref": "#/299"
},
{
- "$ref": "#/322"
+ "$ref": "#/300"
},
{
"$ref": "#/2"
}
]
},
- {
- "$type": "ObjectType",
- "name": "ImageInfoProperties",
- "properties": {
- "type": {
- "type": {
- "$ref": "#/327"
- },
- "flags": 1,
- "description": "The type of image session hosts use in the hostpool."
- },
- "marketplaceInfo": {
- "type": {
- "$ref": "#/328"
- },
- "flags": 0,
- "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type."
- },
- "customInfo": {
- "type": {
- "$ref": "#/329"
- },
- "flags": 0,
- "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type."
- }
- }
- },
{
"$type": "StringLiteralType",
- "value": "Marketplace"
+ "value": "Enable"
},
{
"$type": "StringLiteralType",
- "value": "Custom"
+ "value": "Disable"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/325"
+ "$ref": "#/302"
},
{
- "$ref": "#/326"
+ "$ref": "#/303"
},
{
"$ref": "#/2"
@@ -4315,95 +4504,28 @@
]
},
{
- "$type": "ObjectType",
- "name": "MarketplaceInfoProperties",
- "properties": {
- "offer": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The offer of the image."
- },
- "publisher": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The publisher of the image."
- },
- "sku": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The sku of the image."
- },
- "exactVersion": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The exact version of the image."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "CustomInfoProperties",
- "properties": {
- "resourceId": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The resource id of the custom image."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "DomainInfoProperties",
- "properties": {
- "joinType": {
- "type": {
- "$ref": "#/333"
- },
- "flags": 1,
- "description": "The type of domain join done by the virtual machine."
- },
- "activeDirectoryInfo": {
- "type": {
- "$ref": "#/334"
- },
- "flags": 0,
- "description": "Active directory info. Only one should be populated based on the join type."
- },
- "azureActiveDirectoryInfo": {
- "type": {
- "$ref": "#/336"
- },
- "flags": 0,
- "description": "Azure active directory info. Only one should be populated based on the join type."
- }
- }
+ "$type": "StringLiteralType",
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "ActiveDirectory"
+ "value": "Deallocate"
},
{
"$type": "StringLiteralType",
- "value": "AzureActiveDirectory"
+ "value": "Hibernate"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/331"
+ "$ref": "#/305"
},
{
- "$ref": "#/332"
+ "$ref": "#/306"
+ },
+ {
+ "$ref": "#/307"
},
{
"$ref": "#/2"
@@ -4411,115 +4533,83 @@
]
},
{
- "$type": "ObjectType",
- "name": "ActiveDirectoryInfoProperties",
- "properties": {
- "domainCredentials": {
- "type": {
- "$ref": "#/335"
- },
- "flags": 1,
- "description": "Credentials needed to create the virtual machine."
+ "$type": "IntegerType",
+ "minValue": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hibernate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/310"
},
- "ouPath": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The organizational unit(OU) path."
+ {
+ "$ref": "#/311"
},
- "domainName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The domain a virtual machine connected to a hostpool will join."
+ {
+ "$ref": "#/312"
+ },
+ {
+ "$ref": "#/2"
}
- }
+ ]
},
{
- "$type": "ObjectType",
- "name": "KeyVaultCredentialsProperties",
- "properties": {
- "usernameKeyVaultSecretUri": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The uri to access the secret that the username is stored in."
- },
- "passwordKeyVaultSecretUri": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The uri to access the secret that the password is stored in."
- }
- }
+ "$type": "StringLiteralType",
+ "value": "Enable"
},
{
- "$type": "ObjectType",
- "name": "AzureActiveDirectoryInfoProperties",
- "properties": {
- "mdmProviderGuid": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The Mobile Device Management(MDM) guid."
- }
- }
+ "$type": "StringLiteralType",
+ "value": "Disable"
},
{
- "$type": "ObjectType",
- "name": "SecurityInfoProperties",
- "properties": {
- "type": {
- "type": {
- "$ref": "#/341"
- },
- "flags": 0,
- "description": "The security type used by virtual machine in hostpool session host. Default is Standard."
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/314"
},
- "secureBootEnabled": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Whether to use secureBoot on the virtual machine."
+ {
+ "$ref": "#/315"
},
- "vTpmEnabled": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Whether to use vTPM on the virtual machine."
+ {
+ "$ref": "#/2"
}
- }
+ ]
},
{
"$type": "StringLiteralType",
- "value": "Standard"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "TrustedLaunch"
+ "value": "Deallocate"
},
{
"$type": "StringLiteralType",
- "value": "ConfidentialVM"
+ "value": "Hibernate"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/338"
+ "$ref": "#/317"
},
{
- "$ref": "#/339"
+ "$ref": "#/318"
},
{
- "$ref": "#/340"
+ "$ref": "#/319"
},
{
"$ref": "#/2"
@@ -4527,593 +4617,502 @@
]
},
{
- "$type": "ObjectType",
- "name": "BootDiagnosticsInfoProperties",
- "properties": {
- "enabled": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Whether boot diagnostics should be enabled on the Virtual Machine."
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hibernate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/321"
},
- "storageUri": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Uri of the storage account to use for placing the console output and screenshot.
If storageUri is not specified while enabling boot diagnostics, managed storage will be used."
+ {
+ "$ref": "#/322"
+ },
+ {
+ "$ref": "#/323"
+ },
+ {
+ "$ref": "#/2"
}
- }
+ ]
},
{
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/308"
- },
- "flags": 0
+ "$type": "StringLiteralType",
+ "value": "Enable"
},
{
- "$type": "StringType",
- "minLength": 3,
- "maxLength": 100,
- "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
+ "$type": "StringLiteralType",
+ "value": "Disable"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/325"
+ },
+ {
+ "$ref": "#/326"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools/msixPackages"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "2024-08-08-preview"
+ "value": "Deallocate"
},
{
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools/msixPackages",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
+ "$type": "StringLiteralType",
+ "value": "Hibernate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/328"
},
- "name": {
- "type": {
- "$ref": "#/344"
- },
- "flags": 9,
- "description": "The resource name"
+ {
+ "$ref": "#/329"
},
- "type": {
- "type": {
- "$ref": "#/345"
- },
- "flags": 10,
- "description": "The resource type"
+ {
+ "$ref": "#/330"
},
- "apiVersion": {
- "type": {
- "$ref": "#/346"
- },
- "flags": 10,
- "description": "The resource api version"
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Deallocate"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Hibernate"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/332"
},
- "properties": {
- "type": {
- "$ref": "#/348"
- },
- "flags": 1,
- "description": "Detailed properties for MSIX Package"
+ {
+ "$ref": "#/333"
},
- "systemData": {
- "type": {
- "$ref": "#/25"
- },
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ {
+ "$ref": "#/334"
+ },
+ {
+ "$ref": "#/2"
}
- }
+ ]
},
{
- "$type": "ObjectType",
- "name": "MsixPackageProperties",
- "properties": {
- "imagePath": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "VHD/CIM image path on Network Share."
- },
- "packageName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Package Name from appxmanifest.xml."
- },
- "packageFamilyName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name."
- },
- "displayName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "User friendly Name to be displayed in the portal."
- },
- "packageRelativePath": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Relative Path to the package inside the image."
- },
- "isRegularRegistration": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Specifies how to register Package in feed."
- },
- "isActive": {
- "type": {
- "$ref": "#/7"
- },
- "flags": 0,
- "description": "Make this version of the package the active one across the hostpool."
- },
- "packageDependencies": {
- "type": {
- "$ref": "#/350"
- },
- "flags": 0,
- "description": "List of package dependencies."
- },
- "version": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Package Version found in the appxmanifest.xml."
- },
- "lastUpdated": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Date Package was last updated, found in the appxmanifest.xml."
- },
- "packageApplications": {
- "type": {
- "$ref": "#/352"
- },
- "flags": 0,
- "description": "List of package applications."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "MsixPackageDependencies",
- "properties": {
- "dependencyName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
- },
- "publisher": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Name of dependency publisher."
- },
- "minVersion": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Dependency version required."
- }
- }
+ "$type": "StringLiteralType",
+ "value": "Enable"
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/349"
- }
+ "$type": "StringLiteralType",
+ "value": "Disable"
},
{
- "$type": "ObjectType",
- "name": "MsixPackageApplications",
- "properties": {
- "appId": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Package Application Id, found in appxmanifest.xml."
- },
- "description": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Description of Package Application."
- },
- "appUserModelID": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml."
- },
- "friendlyName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "User friendly name."
- },
- "iconImageName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "User friendly name."
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/336"
},
- "rawIcon": {
- "type": {
- "$ref": "#/221"
- },
- "flags": 0,
- "description": "the icon a 64 bit string as a byte array."
+ {
+ "$ref": "#/337"
},
- "rawPng": {
- "type": {
- "$ref": "#/221"
- },
- "flags": 0,
- "description": "the icon a 64 bit string as a byte array."
+ {
+ "$ref": "#/2"
}
- }
- },
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/351"
- }
- },
- {
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools/msixPackages@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/347"
- },
- "flags": 0
- },
- {
- "$type": "StringType",
- "minLength": 3,
- "maxLength": 100,
- "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$"
+ ]
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/appAttachPackages"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "2024-08-08-preview"
+ "value": "Deallocate"
},
{
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/appAttachPackages",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
- "name": {
- "type": {
- "$ref": "#/354"
- },
- "flags": 9,
- "description": "The resource name"
- },
- "type": {
- "type": {
- "$ref": "#/355"
- },
- "flags": 10,
- "description": "The resource type"
- },
- "apiVersion": {
- "type": {
- "$ref": "#/356"
- },
- "flags": 10,
- "description": "The resource api version"
- },
- "properties": {
- "type": {
- "$ref": "#/358"
- },
- "flags": 1,
- "description": "Detailed properties for App Attach Package"
- },
- "tags": {
- "type": {
- "$ref": "#/375"
- },
- "flags": 0,
- "description": "Resource tags."
- },
- "location": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The geo-location where the resource lives"
- },
- "systemData": {
- "type": {
- "$ref": "#/25"
- },
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
- }
- }
+ "$type": "StringLiteralType",
+ "value": "Hibernate"
},
{
- "$type": "ObjectType",
- "name": "AppAttachPackageProperties",
- "properties": {
- "provisioningState": {
- "type": {
- "$ref": "#/363"
- },
- "flags": 2,
- "description": "The provisioning state of the App Attach Package."
- },
- "image": {
- "type": {
- "$ref": "#/364"
- },
- "flags": 0,
- "description": "Detailed properties for App Attach Package"
- },
- "hostPoolReferences": {
- "type": {
- "$ref": "#/370"
- },
- "flags": 0,
- "description": "List of Hostpool resource Ids."
- },
- "keyVaultURL": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "URL of keyvault location to store certificate"
- },
- "failHealthCheckOnStagingFailure": {
- "type": {
- "$ref": "#/374"
- },
- "flags": 0,
- "description": "Parameter indicating how the health check should behave if this package fails staging"
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/339"
},
- "packageOwnerName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Specific name of package owner, is \"AppAttach\" for native app attach packages"
+ {
+ "$ref": "#/340"
},
- "packageLookbackUrl": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Lookback url to third party control plane, is null for native app attach packages"
+ {
+ "$ref": "#/341"
},
- "customData": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "Field that can be populated with custom data and filtered on in list GET calls"
+ {
+ "$ref": "#/2"
}
- }
- },
- {
- "$type": "StringLiteralType",
- "value": "Succeeded"
+ ]
},
{
"$type": "StringLiteralType",
- "value": "Provisioning"
+ "value": "None"
},
{
"$type": "StringLiteralType",
- "value": "Failed"
+ "value": "Deallocate"
},
{
"$type": "StringLiteralType",
- "value": "Canceled"
+ "value": "Hibernate"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/359"
+ "$ref": "#/343"
},
{
- "$ref": "#/360"
+ "$ref": "#/344"
},
{
- "$ref": "#/361"
- },
- {
- "$ref": "#/362"
+ "$ref": "#/345"
},
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/287"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-08-08-preview"
+ },
{
"$type": "ObjectType",
- "name": "AppAttachPackageInfoProperties",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
"properties": {
- "packageAlias": {
+ "id": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "Alias of App Attach Package. Assigned at import time"
+ "flags": 10,
+ "description": "The resource id"
},
- "imagePath": {
+ "name": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/284"
},
- "flags": 0,
- "description": "VHD/CIM/APP-V image path on Network Share."
+ "flags": 9,
+ "description": "The resource name"
},
- "packageName": {
+ "type": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/348"
},
- "flags": 0,
- "description": "Package Name from appxmanifest.xml."
+ "flags": 10,
+ "description": "The resource type"
},
- "packageFamilyName": {
+ "apiVersion": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/349"
},
- "flags": 0,
- "description": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml."
+ "flags": 10,
+ "description": "The resource api version"
},
- "packageFullName": {
+ "properties": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/351"
},
- "flags": 0,
- "description": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml."
+ "flags": 1,
+ "description": "Detailed properties for ScalingPlanPooledSchedule"
},
- "displayName": {
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScalingPlanPooledScheduleProperties",
+ "properties": {
+ "name": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "User friendly Name to be displayed in the portal."
+ "description": "Name of the ScalingPlanPooledSchedule"
},
- "packageRelativePath": {
+ "daysOfWeek": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/360"
+ },
+ "flags": 1,
+ "description": "Set of days of the week on which this schedule is active."
+ },
+ "rampUpStartTime": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 1,
+ "description": "Starting time for ramp up period."
+ },
+ "rampUpLoadBalancingAlgorithm": {
+ "type": {
+ "$ref": "#/363"
},
"flags": 0,
- "description": "Relative Path to the package inside the image."
+ "description": "Load balancing algorithm for ramp up period."
},
- "isRegularRegistration": {
+ "rampUpMinimumHostsPct": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/177"
},
"flags": 0,
- "description": "Specifies how to register Package in feed."
+ "description": "Minimum host percentage for ramp up period."
},
- "isActive": {
+ "rampUpCapacityThresholdPct": {
+ "type": {
+ "$ref": "#/178"
+ },
+ "flags": 1,
+ "description": "Capacity threshold for ramp up period."
+ },
+ "peakStartTime": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 1,
+ "description": "Starting time for peak period."
+ },
+ "peakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/366"
},
"flags": 0,
- "description": "Make this version of the package the active one across the hostpool."
+ "description": "Load balancing algorithm for peak period."
},
- "packageDependencies": {
+ "rampDownStartTime": {
+ "type": {
+ "$ref": "#/171"
+ },
+ "flags": 1,
+ "description": "Starting time for ramp down period."
+ },
+ "rampDownLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/365"
+ "$ref": "#/369"
},
"flags": 0,
- "description": "List of package dependencies."
+ "description": "Load balancing algorithm for ramp down period."
},
- "version": {
+ "rampDownMinimumHostsPct": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/177"
},
"flags": 0,
- "description": "Package Version found in the appxmanifest.xml."
+ "description": "Minimum host percentage for ramp down period."
},
- "lastUpdated": {
+ "rampDownCapacityThresholdPct": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/178"
+ },
+ "flags": 1,
+ "description": "Capacity threshold for ramp down period."
+ },
+ "rampDownForceLogoffUsers": {
+ "type": {
+ "$ref": "#/12"
},
"flags": 0,
- "description": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml."
+ "description": "Should users be logged off forcefully from hosts."
},
- "packageApplications": {
+ "rampDownStopHostsWhen": {
"type": {
- "$ref": "#/366"
+ "$ref": "#/372"
},
"flags": 0,
- "description": "List of package applications."
+ "description": "Specifies when to stop hosts during ramp down period."
},
- "certificateName": {
+ "rampDownWaitTimeMinutes": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/64"
},
"flags": 0,
- "description": "Certificate name found in the appxmanifest.xml."
+ "description": "Number of minutes to wait to stop hosts during ramp down period."
},
- "certificateExpiry": {
+ "rampDownNotificationMessage": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Date certificate expires, found in the appxmanifest.xml."
+ "description": "Notification message for users during ramp down period."
},
- "isPackageTimestamped": {
+ "offPeakStartTime": {
"type": {
- "$ref": "#/369"
+ "$ref": "#/171"
+ },
+ "flags": 1,
+ "description": "Starting time for off-peak period."
+ },
+ "offPeakLoadBalancingAlgorithm": {
+ "type": {
+ "$ref": "#/375"
},
"flags": 0,
- "description": "Is package timestamped so it can ignore the certificate expiry date"
+ "description": "Load balancing algorithm for off-peak period."
}
}
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/349"
- }
+ "$type": "StringLiteralType",
+ "value": "Monday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Tuesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Wednesday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Thursday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Friday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Saturday"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/352"
+ },
+ {
+ "$ref": "#/353"
+ },
+ {
+ "$ref": "#/354"
+ },
+ {
+ "$ref": "#/355"
+ },
+ {
+ "$ref": "#/356"
+ },
+ {
+ "$ref": "#/357"
+ },
+ {
+ "$ref": "#/358"
+ }
+ ]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/351"
+ "$ref": "#/359"
}
},
{
"$type": "StringLiteralType",
- "value": "Timestamped"
+ "value": "BreadthFirst"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DepthFirst"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/361"
+ },
+ {
+ "$ref": "#/362"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BreadthFirst"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "DepthFirst"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/364"
+ },
+ {
+ "$ref": "#/365"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "BreadthFirst"
},
{
"$type": "StringLiteralType",
- "value": "NotTimestamped"
+ "value": "DepthFirst"
},
{
"$type": "UnionType",
@@ -5130,54 +5129,55 @@
]
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/2"
- }
+ "$type": "StringLiteralType",
+ "value": "ZeroSessions"
},
{
"$type": "StringLiteralType",
- "value": "Unhealthy"
+ "value": "ZeroActiveSessions"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/370"
+ },
+ {
+ "$ref": "#/371"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
},
{
"$type": "StringLiteralType",
- "value": "NeedsAssistance"
+ "value": "BreadthFirst"
},
{
"$type": "StringLiteralType",
- "value": "DoNotFail"
+ "value": "DepthFirst"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/371"
- },
- {
- "$ref": "#/372"
+ "$ref": "#/373"
},
{
- "$ref": "#/373"
+ "$ref": "#/374"
},
{
"$ref": "#/2"
}
]
},
- {
- "$type": "ObjectType",
- "name": "TrackedResourceTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
- }
- },
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/appAttachPackages@2024-08-08-preview",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/357"
+ "$ref": "#/350"
},
"flags": 0
},
@@ -5202,7 +5202,7 @@
},
"name": {
"type": {
- "$ref": "#/209"
+ "$ref": "#/207"
},
"flags": 9,
"description": "The resource name"
@@ -5230,7 +5230,7 @@
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -5271,7 +5271,7 @@
},
"iconContent": {
"type": {
- "$ref": "#/221"
+ "$ref": "#/16"
},
"flags": 2,
"description": "The icon a 64 bit string as a byte array."
@@ -5336,11 +5336,11 @@
"$ref": "#/386"
},
"flags": 2,
- "description": "Detailed properties for SessionHostConfiguration"
+ "description": "Detailed properties for ActiveSessionHostConfiguration"
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -5360,10 +5360,10 @@
},
"friendlyName": {
"type": {
- "$ref": "#/303"
+ "$ref": "#/241"
},
"flags": 0,
- "description": "Friendly name to describe this version of the SessionHostConfiguration."
+ "description": "Friendly name to describe this version of the SessionHostConfiguration"
},
"vmTags": {
"type": {
@@ -5388,7 +5388,7 @@
},
"vmNamePrefix": {
"type": {
- "$ref": "#/316"
+ "$ref": "#/248"
},
"flags": 1,
"description": "The prefix that should be associated with session host names"
@@ -5402,7 +5402,7 @@
},
"networkInfo": {
"type": {
- "$ref": "#/318"
+ "$ref": "#/250"
},
"flags": 1,
"description": "Network information."
@@ -5416,7 +5416,7 @@
},
"diskInfo": {
"type": {
- "$ref": "#/319"
+ "$ref": "#/251"
},
"flags": 1,
"description": "Disk information."
@@ -5430,35 +5430,35 @@
},
"imageInfo": {
"type": {
- "$ref": "#/324"
+ "$ref": "#/256"
},
"flags": 1,
- "description": "Image configurations of HostPool."
+ "description": "Image configurations of the HostPool."
},
"domainInfo": {
"type": {
- "$ref": "#/330"
+ "$ref": "#/262"
},
"flags": 1,
"description": "Domain configurations of session hosts."
},
"securityInfo": {
"type": {
- "$ref": "#/337"
+ "$ref": "#/269"
},
"flags": 0,
"description": "Security information."
},
"vmAdminCredentials": {
"type": {
- "$ref": "#/335"
+ "$ref": "#/267"
},
"flags": 1,
"description": "Local Admin credentials for session hosts."
},
"bootDiagnosticsInfo": {
"type": {
- "$ref": "#/342"
+ "$ref": "#/274"
},
"flags": 0,
"description": "Boot Diagnostics information."
@@ -5476,7 +5476,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/53"
+ "$ref": "#/64"
}
},
{
@@ -5488,196 +5488,6 @@
},
"flags": 1
},
- {
- "$type": "StringType",
- "minLength": 1,
- "maxLength": 24
- },
- {
- "$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions"
- },
- {
- "$type": "StringLiteralType",
- "value": "2024-08-08-preview"
- },
- {
- "$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions",
- "properties": {
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 10,
- "description": "The resource id"
- },
- "name": {
- "type": {
- "$ref": "#/390"
- },
- "flags": 9,
- "description": "The resource name"
- },
- "type": {
- "type": {
- "$ref": "#/391"
- },
- "flags": 10,
- "description": "The resource type"
- },
- "apiVersion": {
- "type": {
- "$ref": "#/392"
- },
- "flags": 10,
- "description": "The resource api version"
- },
- "properties": {
- "type": {
- "$ref": "#/394"
- },
- "flags": 2,
- "description": "Detailed properties for UserSession"
- },
- "systemData": {
- "type": {
- "$ref": "#/25"
- },
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "UserSessionProperties",
- "properties": {
- "objectId": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 2,
- "description": "ObjectId of user session. (internal use)"
- },
- "userPrincipalName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The user principal name."
- },
- "applicationType": {
- "type": {
- "$ref": "#/397"
- },
- "flags": 0,
- "description": "Application type of application."
- },
- "sessionState": {
- "type": {
- "$ref": "#/404"
- },
- "flags": 0,
- "description": "State of user session."
- },
- "activeDirectoryUserName": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The active directory user name."
- },
- "createTime": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The timestamp of the user session create."
- }
- }
- },
- {
- "$type": "StringLiteralType",
- "value": "RemoteApp"
- },
- {
- "$type": "StringLiteralType",
- "value": "Desktop"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/395"
- },
- {
- "$ref": "#/396"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "Unknown"
- },
- {
- "$type": "StringLiteralType",
- "value": "Active"
- },
- {
- "$type": "StringLiteralType",
- "value": "Disconnected"
- },
- {
- "$type": "StringLiteralType",
- "value": "Pending"
- },
- {
- "$type": "StringLiteralType",
- "value": "LogOff"
- },
- {
- "$type": "StringLiteralType",
- "value": "UserProfileDiskMounted"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/398"
- },
- {
- "$ref": "#/399"
- },
- {
- "$ref": "#/400"
- },
- {
- "$ref": "#/401"
- },
- {
- "$ref": "#/402"
- },
- {
- "$ref": "#/403"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions@2024-08-08-preview",
- "scopeType": 8,
- "body": {
- "$ref": "#/393"
- },
- "flags": 1
- },
{
"$type": "StringType",
"minLength": 3,
@@ -5705,35 +5515,35 @@
},
"name": {
"type": {
- "$ref": "#/406"
+ "$ref": "#/390"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/407"
+ "$ref": "#/391"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/408"
+ "$ref": "#/392"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/410"
+ "$ref": "#/394"
},
"flags": 2,
"description": "Detailed properties for SessionHost"
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -5760,7 +5570,7 @@
},
"sessions": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/64"
},
"flags": 0,
"description": "Number of sessions on SessionHost."
@@ -5774,7 +5584,7 @@
},
"allowNewSession": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Allow a new session."
@@ -5809,7 +5619,7 @@
},
"status": {
"type": {
- "$ref": "#/423"
+ "$ref": "#/407"
},
"flags": 0,
"description": "Status for a SessionHost."
@@ -5837,9 +5647,9 @@
},
"updateState": {
"type": {
- "$ref": "#/429"
+ "$ref": "#/413"
},
- "flags": 0,
+ "flags": 2,
"description": "Update state of a SessionHost."
},
"lastUpdateTime": {
@@ -5872,7 +5682,7 @@
},
"sessionHostHealthCheckResults": {
"type": {
- "$ref": "#/449"
+ "$ref": "#/433"
},
"flags": 2,
"description": "List of SessionHostHealthCheckReports"
@@ -5931,40 +5741,40 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/411"
+ "$ref": "#/395"
},
{
- "$ref": "#/412"
+ "$ref": "#/396"
},
{
- "$ref": "#/413"
+ "$ref": "#/397"
},
{
- "$ref": "#/414"
+ "$ref": "#/398"
},
{
- "$ref": "#/415"
+ "$ref": "#/399"
},
{
- "$ref": "#/416"
+ "$ref": "#/400"
},
{
- "$ref": "#/417"
+ "$ref": "#/401"
},
{
- "$ref": "#/418"
+ "$ref": "#/402"
},
{
- "$ref": "#/419"
+ "$ref": "#/403"
},
{
- "$ref": "#/420"
+ "$ref": "#/404"
},
{
- "$ref": "#/421"
+ "$ref": "#/405"
},
{
- "$ref": "#/422"
+ "$ref": "#/406"
},
{
"$ref": "#/2"
@@ -5995,19 +5805,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/424"
+ "$ref": "#/408"
},
{
- "$ref": "#/425"
+ "$ref": "#/409"
},
{
- "$ref": "#/426"
+ "$ref": "#/410"
},
{
- "$ref": "#/427"
+ "$ref": "#/411"
},
{
- "$ref": "#/428"
+ "$ref": "#/412"
},
{
"$ref": "#/2"
@@ -6020,21 +5830,21 @@
"properties": {
"healthCheckName": {
"type": {
- "$ref": "#/442"
+ "$ref": "#/426"
},
"flags": 2,
"description": "Represents the name of the health check operation performed."
},
"healthCheckResult": {
"type": {
- "$ref": "#/447"
+ "$ref": "#/431"
},
"flags": 2,
"description": "Represents the Health state of the health check we performed."
},
"additionalFailureDetails": {
"type": {
- "$ref": "#/448"
+ "$ref": "#/432"
},
"flags": 2,
"description": "Additional detailed information on the failure."
@@ -6089,37 +5899,37 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/431"
+ "$ref": "#/415"
},
{
- "$ref": "#/432"
+ "$ref": "#/416"
},
{
- "$ref": "#/433"
+ "$ref": "#/417"
},
{
- "$ref": "#/434"
+ "$ref": "#/418"
},
{
- "$ref": "#/435"
+ "$ref": "#/419"
},
{
- "$ref": "#/436"
+ "$ref": "#/420"
},
{
- "$ref": "#/437"
+ "$ref": "#/421"
},
{
- "$ref": "#/438"
+ "$ref": "#/422"
},
{
- "$ref": "#/439"
+ "$ref": "#/423"
},
{
- "$ref": "#/440"
+ "$ref": "#/424"
},
{
- "$ref": "#/441"
+ "$ref": "#/425"
},
{
"$ref": "#/2"
@@ -6146,16 +5956,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/443"
+ "$ref": "#/427"
},
{
- "$ref": "#/444"
+ "$ref": "#/428"
},
{
- "$ref": "#/445"
+ "$ref": "#/429"
},
{
- "$ref": "#/446"
+ "$ref": "#/430"
},
{
"$ref": "#/2"
@@ -6175,7 +5985,7 @@
},
"errorCode": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/64"
},
"flags": 2,
"description": "Error code corresponding for the failure."
@@ -6192,7 +6002,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/430"
+ "$ref": "#/414"
}
},
{
@@ -6200,165 +6010,210 @@
"name": "Microsoft.DesktopVirtualization/hostPools/sessionHosts@2024-08-08-preview",
"scopeType": 8,
"body": {
- "$ref": "#/409"
+ "$ref": "#/393"
},
"flags": 1
},
{
- "$type": "ResourceFunctionType",
- "name": "retrieveRegistrationToken",
- "resourceType": "Microsoft.DesktopVirtualization/hostPools",
- "apiVersion": "2024-08-08-preview",
- "output": {
- "$ref": "#/239"
- }
+ "$type": "StringType",
+ "minLength": 1,
+ "maxLength": 24
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-08-08-preview"
},
{
"$type": "ObjectType",
- "name": "RegistrationTokenList",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions",
"properties": {
- "value": {
+ "id": {
"type": {
- "$ref": "#/455"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "List of RegistrationToken definitions."
+ "flags": 10,
+ "description": "The resource id"
},
- "nextLink": {
+ "name": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/435"
+ },
+ "flags": 9,
+ "description": "The resource name"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/436"
+ },
+ "flags": 10,
+ "description": "The resource type"
+ },
+ "apiVersion": {
+ "type": {
+ "$ref": "#/437"
+ },
+ "flags": 10,
+ "description": "The resource api version"
+ },
+ "properties": {
+ "type": {
+ "$ref": "#/439"
},
"flags": 2,
- "description": "Link to the next page of results."
+ "description": "Detailed properties for UserSession"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
{
"$type": "ObjectType",
- "name": "RegistrationTokenMinimal",
+ "name": "UserSessionProperties",
"properties": {
- "expirationTime": {
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ObjectId of user session. (internal use)"
+ },
+ "userPrincipalName": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "Expiration time of registration token."
+ "description": "The user principal name."
},
- "token": {
+ "applicationType": {
"type": {
- "$ref": "#/454"
+ "$ref": "#/442"
},
"flags": 0,
- "description": "The registration token base64 encoded string."
- }
- }
- },
- {
- "$type": "StringType",
- "sensitive": true
- },
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/453"
- }
- },
- {
- "$type": "ResourceFunctionType",
- "name": "listRegistrationTokens",
- "resourceType": "Microsoft.DesktopVirtualization/hostPools",
- "apiVersion": "2024-08-08-preview",
- "output": {
- "$ref": "#/452"
- }
- },
- {
- "$type": "ObjectType",
- "name": "ImportPackageInfoRequest",
- "properties": {
- "path": {
+ "description": "Application type of application."
+ },
+ "sessionState": {
+ "type": {
+ "$ref": "#/449"
+ },
+ "flags": 0,
+ "description": "State of user session."
+ },
+ "activeDirectoryUserName": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "URI to Image"
+ "description": "The active directory user name."
},
- "packageArchitecture": {
+ "createTime": {
"type": {
- "$ref": "#/465"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "Possible device architectures that an app attach package can be configured for"
+ "description": "The timestamp of the user session create."
}
}
},
{
"$type": "StringLiteralType",
- "value": "ARM"
+ "value": "RemoteApp"
},
{
"$type": "StringLiteralType",
- "value": "ARM64"
+ "value": "Desktop"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/440"
+ },
+ {
+ "$ref": "#/441"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
},
{
"$type": "StringLiteralType",
- "value": "x86"
+ "value": "Unknown"
},
{
"$type": "StringLiteralType",
- "value": "x64"
+ "value": "Active"
},
{
"$type": "StringLiteralType",
- "value": "Neutral"
+ "value": "Disconnected"
},
{
"$type": "StringLiteralType",
- "value": "x86a64"
+ "value": "Pending"
},
{
"$type": "StringLiteralType",
- "value": "ALL"
+ "value": "LogOff"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserProfileDiskMounted"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/458"
- },
- {
- "$ref": "#/459"
+ "$ref": "#/443"
},
{
- "$ref": "#/460"
+ "$ref": "#/444"
},
{
- "$ref": "#/461"
+ "$ref": "#/445"
},
{
- "$ref": "#/462"
+ "$ref": "#/446"
},
{
- "$ref": "#/463"
+ "$ref": "#/447"
},
{
- "$ref": "#/464"
+ "$ref": "#/448"
},
{
"$ref": "#/2"
}
]
},
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions@2024-08-08-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/438"
+ },
+ "flags": 1
+ },
{
"$type": "ObjectType",
- "name": "AppAttachPackageList",
+ "name": "RegistrationTokenList",
"properties": {
"value": {
"type": {
- "$ref": "#/469"
+ "$ref": "#/453"
},
"flags": 0,
- "description": "List of App Attach Package definitions."
+ "description": "List of RegistrationToken definitions."
},
"nextLink": {
"type": {
@@ -6371,83 +6226,46 @@
},
{
"$type": "ObjectType",
- "name": "AppAttachPackage",
+ "name": "RegistrationTokenMinimal",
"properties": {
- "properties": {
- "type": {
- "$ref": "#/358"
- },
- "flags": 1,
- "description": "Detailed properties for App Attach Package"
- },
- "tags": {
- "type": {
- "$ref": "#/468"
- },
- "flags": 0,
- "description": "Resource tags."
- },
- "location": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The geo-location where the resource lives"
- },
- "id": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 2,
- "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
- },
- "name": {
+ "expirationTime": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The name of the resource"
+ "flags": 0,
+ "description": "Expiration time of registration token."
},
- "type": {
+ "token": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
- },
- "systemData": {
- "type": {
- "$ref": "#/25"
- },
- "flags": 2,
- "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ "flags": 0,
+ "description": "The registration token base64 encoded string."
}
}
},
{
- "$type": "ObjectType",
- "name": "TrackedResourceTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/452"
}
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/467"
+ "$type": "ResourceFunctionType",
+ "name": "listRegistrationTokens",
+ "resourceType": "Microsoft.DesktopVirtualization/hostPools",
+ "apiVersion": "2024-08-08-preview",
+ "output": {
+ "$ref": "#/451"
}
},
{
"$type": "ResourceFunctionType",
- "name": "importAppAttachPackageInfo",
+ "name": "retrieveRegistrationToken",
"resourceType": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2024-08-08-preview",
"output": {
- "$ref": "#/466"
- },
- "input": {
- "$ref": "#/457"
+ "$ref": "#/83"
}
},
{
@@ -6469,17 +6287,17 @@
"properties": {
"value": {
"type": {
- "$ref": "#/477"
+ "$ref": "#/462"
},
- "flags": 0,
- "description": "List of MSIX package properties from give MSIX Image."
+ "flags": 1,
+ "description": "The ExpandMsixImage items on this page"
},
"nextLink": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "Link to the next page of results."
+ "flags": 0,
+ "description": "The link to the next page of items"
}
}
},
@@ -6489,7 +6307,7 @@
"properties": {
"properties": {
"type": {
- "$ref": "#/474"
+ "$ref": "#/459"
},
"flags": 0,
"description": "Detailed properties for ExpandMsixImage"
@@ -6517,7 +6335,7 @@
},
"systemData": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/27"
},
"flags": 2,
"description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
@@ -6579,21 +6397,21 @@
},
"isRegularRegistration": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Specifies how to register Package in feed."
},
"isActive": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Make this version of the package the active one across the hostpool."
},
"packageDependencies": {
"type": {
- "$ref": "#/475"
+ "$ref": "#/460"
},
"flags": 0,
"description": "List of package dependencies."
@@ -6603,7 +6421,7 @@
"$ref": "#/2"
},
"flags": 0,
- "description": "Package Version found in the appxmanifest.xml."
+ "description": "Package version found in the appxmanifest.xml."
},
"lastUpdated": {
"type": {
@@ -6614,7 +6432,7 @@
},
"packageApplications": {
"type": {
- "$ref": "#/476"
+ "$ref": "#/461"
},
"flags": 0,
"description": "List of package applications."
@@ -6638,19 +6456,19 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/349"
+ "$ref": "#/13"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/351"
+ "$ref": "#/15"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/473"
+ "$ref": "#/458"
}
},
{
@@ -6659,80 +6477,188 @@
"resourceType": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2024-08-08-preview",
"output": {
- "$ref": "#/472"
+ "$ref": "#/457"
},
"input": {
- "$ref": "#/471"
+ "$ref": "#/456"
}
},
{
"$type": "ObjectType",
- "name": "UpdateSessionHostsRequestBody",
+ "name": "ImportPackageInfoRequest",
"properties": {
- "scheduledDateTime": {
+ "path": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately"
+ "description": "URI to Image"
},
- "scheduledDateTimeZone": {
+ "packageArchitecture": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/472"
},
"flags": 0,
- "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid."
+ "description": "Possible device architectures that an app attach package can be configured for"
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ARM"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ARM64"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "x86"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "x64"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Neutral"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "x86a64"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ALL"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/465"
},
- "update": {
+ {
+ "$ref": "#/466"
+ },
+ {
+ "$ref": "#/467"
+ },
+ {
+ "$ref": "#/468"
+ },
+ {
+ "$ref": "#/469"
+ },
+ {
+ "$ref": "#/470"
+ },
+ {
+ "$ref": "#/471"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AppAttachPackageList",
+ "properties": {
+ "value": {
+ "type": {
+ "$ref": "#/476"
+ },
+ "flags": 1,
+ "description": "The AppAttachPackage items on this page"
+ },
+ "nextLink": {
"type": {
- "$ref": "#/480"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object."
+ "description": "The link to the next page of items"
}
}
},
{
"$type": "ObjectType",
- "name": "HostPoolUpdateConfigurationPatchProperties",
+ "name": "AppAttachPackage",
"properties": {
- "deleteOriginalVm": {
+ "properties": {
"type": {
- "$ref": "#/7"
+ "$ref": "#/5"
},
- "flags": 0,
- "description": "Whether not to save original disk. False by default."
+ "flags": 1,
+ "description": "Detailed properties for App Attach Package"
},
- "maxVmsRemoved": {
+ "tags": {
"type": {
- "$ref": "#/302"
+ "$ref": "#/475"
},
"flags": 0,
- "description": "The maximum number of virtual machines to be removed during hostpool update."
+ "description": "Resource tags."
},
- "logOffDelayMinutes": {
+ "location": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "Grace period before logging off users in minutes."
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
},
- "logOffMessage": {
+ "id": {
"type": {
- "$ref": "#/303"
+ "$ref": "#/2"
},
- "flags": 0,
- "description": "Log off message sent to user for logoff."
+ "flags": 2,
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The name of the resource"
+ },
+ "type": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/27"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/474"
+ }
+ },
{
"$type": "ResourceFunctionType",
- "name": "initiateSessionHostUpdate",
- "resourceType": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
+ "name": "importAppAttachPackageInfo",
+ "resourceType": "Microsoft.DesktopVirtualization/hostPools",
"apiVersion": "2024-08-08-preview",
+ "output": {
+ "$ref": "#/473"
+ },
"input": {
- "$ref": "#/479"
+ "$ref": "#/464"
}
},
{
@@ -6741,14 +6667,14 @@
"properties": {
"action": {
"type": {
- "$ref": "#/488"
+ "$ref": "#/484"
},
"flags": 1,
"description": "Action types for controlling hostpool update."
},
"cancelMessage": {
"type": {
- "$ref": "#/303"
+ "$ref": "#/241"
},
"flags": 0,
"description": "The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'."
@@ -6779,19 +6705,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/483"
+ "$ref": "#/479"
},
{
- "$ref": "#/484"
+ "$ref": "#/480"
},
{
- "$ref": "#/485"
+ "$ref": "#/481"
},
{
- "$ref": "#/486"
+ "$ref": "#/482"
},
{
- "$ref": "#/487"
+ "$ref": "#/483"
},
{
"$ref": "#/2"
@@ -6804,9 +6730,85 @@
"resourceType": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
"apiVersion": "2024-08-08-preview",
"input": {
- "$ref": "#/482"
+ "$ref": "#/478"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UpdateSessionHostsRequestBody",
+ "properties": {
+ "scheduledDateTime": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately"
+ },
+ "scheduledDateTimeZone": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid."
+ },
+ "update": {
+ "type": {
+ "$ref": "#/487"
+ },
+ "flags": 0,
+ "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "HostPoolUpdateConfigurationPatchProperties",
+ "properties": {
+ "deleteOriginalVm": {
+ "type": {
+ "$ref": "#/12"
+ },
+ "flags": 0,
+ "description": "Whether not to save original disk. False by default."
+ },
+ "maxVmsRemoved": {
+ "type": {
+ "$ref": "#/282"
+ },
+ "flags": 0,
+ "description": "The maximum number of virtual machines to be removed during hostpool update."
+ },
+ "logOffDelayMinutes": {
+ "type": {
+ "$ref": "#/64"
+ },
+ "flags": 0,
+ "description": "Grace period before logging off users in minutes."
+ },
+ "logOffMessage": {
+ "type": {
+ "$ref": "#/241"
+ },
+ "flags": 0,
+ "description": "Log off message sent to user for logoff. Default value is an empty string."
+ }
+ }
+ },
+ {
+ "$type": "ResourceFunctionType",
+ "name": "initiateSessionHostUpdate",
+ "resourceType": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
+ "apiVersion": "2024-08-08-preview",
+ "input": {
+ "$ref": "#/486"
}
},
+ {
+ "$type": "ResourceFunctionType",
+ "name": "retryProvisioning",
+ "resourceType": "Microsoft.DesktopVirtualization/hostPools/sessionHosts",
+ "apiVersion": "2024-08-08-preview"
+ },
{
"$type": "ResourceFunctionType",
"name": "disconnect",
@@ -6841,11 +6843,5 @@
"input": {
"$ref": "#/491"
}
- },
- {
- "$type": "ResourceFunctionType",
- "name": "retryProvisioning",
- "resourceType": "Microsoft.DesktopVirtualization/hostPools/sessionHosts",
- "apiVersion": "2024-08-08-preview"
}
]
\ No newline at end of file
diff --git a/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2023-07-07-preview/types.json b/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-11-01-preview/types.json
similarity index 59%
rename from internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2023-07-07-preview/types.json
rename to internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-11-01-preview/types.json
index 4d098554b..834646075 100644
--- a/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2023-07-07-preview/types.json
+++ b/internal/azure/generated/desktopvirtualization/microsoft.desktopvirtualization/2024-11-01-preview/types.json
@@ -1,8 +1,9 @@
[
{
"$type": "StringType",
- "minLength": 3,
- "maxLength": 64
+ "minLength": 1,
+ "maxLength": 255,
+ "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
},
{
"$type": "StringLiteralType",
@@ -13,7 +14,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -47,27 +48,13 @@
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/16"
+ "$ref": "#/5"
},
"flags": 0,
"description": "Detailed properties for Workspace"
},
- "location": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The geo-location where the resource lives"
- },
"managedBy": {
"type": {
"$ref": "#/2"
@@ -77,10 +64,10 @@
},
"kind": {
"type": {
- "$ref": "#/36"
+ "$ref": "#/37"
},
"flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
"etag": {
"type": {
@@ -89,153 +76,50 @@
"flags": 2,
"description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- "tags": {
- "type": {
- "$ref": "#/37"
- },
- "flags": 0,
- "description": "Resource tags."
- },
"identity": {
"type": {
"$ref": "#/38"
},
- "flags": 0
+ "flags": 0,
+ "description": "Managed service identity (system assigned and/or user assigned identities)"
},
"sku": {
- "type": {
- "$ref": "#/40"
- },
- "flags": 0
- },
- "plan": {
"type": {
"$ref": "#/47"
},
- "flags": 0
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "SystemData",
- "properties": {
- "createdBy": {
- "type": {
- "$ref": "#/2"
- },
"flags": 0,
- "description": "The identity that created the resource."
+ "description": "The resource model definition representing SKU"
},
- "createdByType": {
+ "plan": {
"type": {
- "$ref": "#/10"
+ "$ref": "#/54"
},
"flags": 0,
- "description": "The type of identity that created the resource."
+ "description": "Plan for the resource."
},
- "createdAt": {
+ "tags": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/55"
},
"flags": 0,
- "description": "The timestamp of resource creation (UTC)."
+ "description": "Resource tags."
},
- "lastModifiedBy": {
+ "location": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "The identity that last modified the resource."
- },
- "lastModifiedByType": {
- "type": {
- "$ref": "#/15"
- },
- "flags": 0,
- "description": "The type of identity that last modified the resource."
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
},
- "lastModifiedAt": {
+ "systemData": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/25"
},
- "flags": 0,
- "description": "The timestamp of resource last modification (UTC)"
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
- {
- "$type": "StringLiteralType",
- "value": "User"
- },
- {
- "$type": "StringLiteralType",
- "value": "Application"
- },
- {
- "$type": "StringLiteralType",
- "value": "ManagedIdentity"
- },
- {
- "$type": "StringLiteralType",
- "value": "Key"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/6"
- },
- {
- "$ref": "#/7"
- },
- {
- "$ref": "#/8"
- },
- {
- "$ref": "#/9"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
- {
- "$type": "StringLiteralType",
- "value": "User"
- },
- {
- "$type": "StringLiteralType",
- "value": "Application"
- },
- {
- "$type": "StringLiteralType",
- "value": "ManagedIdentity"
- },
- {
- "$type": "StringLiteralType",
- "value": "Key"
- },
- {
- "$type": "UnionType",
- "elements": [
- {
- "$ref": "#/11"
- },
- {
- "$ref": "#/12"
- },
- {
- "$ref": "#/13"
- },
- {
- "$ref": "#/14"
- },
- {
- "$ref": "#/2"
- }
- ]
- },
{
"$type": "ObjectType",
"name": "WorkspaceProperties",
@@ -263,28 +147,28 @@
},
"applicationGroupReferences": {
"type": {
- "$ref": "#/17"
+ "$ref": "#/6"
},
"flags": 0,
"description": "List of applicationGroup resource Ids."
},
"cloudPcResource": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 2,
"description": "Is cloud pc resource."
},
"publicNetworkAccess": {
"type": {
- "$ref": "#/21"
+ "$ref": "#/10"
},
"flags": 0,
"description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints"
},
"privateEndpointConnections": {
"type": {
- "$ref": "#/35"
+ "$ref": "#/36"
},
"flags": 2,
"description": "List of private endpoint connection associated with the specified resource"
@@ -312,10 +196,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/19"
+ "$ref": "#/8"
},
{
- "$ref": "#/20"
+ "$ref": "#/9"
},
{
"$ref": "#/2"
@@ -328,7 +212,7 @@
"properties": {
"properties": {
"type": {
- "$ref": "#/23"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Resource properties."
@@ -338,7 +222,7 @@
"$ref": "#/2"
},
"flags": 2,
- "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
},
"name": {
"type": {
@@ -353,6 +237,13 @@
},
"flags": 2,
"description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
@@ -360,29 +251,42 @@
"$type": "ObjectType",
"name": "PrivateEndpointConnectionProperties",
"properties": {
+ "groupIds": {
+ "type": {
+ "$ref": "#/13"
+ },
+ "flags": 2,
+ "description": "The group ids for the private endpoint resource."
+ },
"privateEndpoint": {
"type": {
- "$ref": "#/24"
+ "$ref": "#/14"
},
"flags": 0,
- "description": "The resource of private end point."
+ "description": "The private endpoint resource."
},
"privateLinkServiceConnectionState": {
"type": {
- "$ref": "#/25"
+ "$ref": "#/15"
},
"flags": 1,
"description": "A collection of information about the state of the connection between service consumer and provider."
},
"provisioningState": {
"type": {
- "$ref": "#/34"
+ "$ref": "#/24"
},
"flags": 2,
"description": "The provisioning state of the private endpoint connection resource."
}
}
},
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
{
"$type": "ObjectType",
"name": "PrivateEndpoint",
@@ -392,7 +296,7 @@
"$ref": "#/2"
},
"flags": 2,
- "description": "The ARM identifier for Private Endpoint"
+ "description": "The ARM identifier for private endpoint."
}
}
},
@@ -402,7 +306,7 @@
"properties": {
"status": {
"type": {
- "$ref": "#/29"
+ "$ref": "#/19"
},
"flags": 0,
"description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
@@ -439,13 +343,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/26"
+ "$ref": "#/16"
},
{
- "$ref": "#/27"
+ "$ref": "#/17"
},
{
- "$ref": "#/28"
+ "$ref": "#/18"
},
{
"$ref": "#/2"
@@ -472,142 +376,327 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/30"
+ "$ref": "#/20"
},
{
- "$ref": "#/31"
+ "$ref": "#/21"
},
{
- "$ref": "#/32"
+ "$ref": "#/22"
},
{
- "$ref": "#/33"
+ "$ref": "#/23"
},
{
"$ref": "#/2"
}
]
},
- {
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/22"
- }
- },
- {
- "$type": "StringType",
- "pattern": "^[-\\w\\._,\\(\\)]+$"
- },
- {
- "$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetTags",
- "properties": {},
- "additionalProperties": {
- "$ref": "#/2"
- }
- },
{
"$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetIdentity",
+ "name": "SystemData",
"properties": {
- "principalId": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 2,
- "description": "The principal ID of resource identity."
- },
- "tenantId": {
+ "createdBy": {
"type": {
"$ref": "#/2"
},
- "flags": 2,
- "description": "The tenant ID of resource."
+ "flags": 0,
+ "description": "The identity that created the resource."
},
- "type": {
+ "createdByType": {
"type": {
- "$ref": "#/39"
+ "$ref": "#/30"
},
"flags": 0,
- "description": "The identity type."
- }
- }
- },
- {
- "$type": "StringLiteralType",
- "value": "SystemAssigned"
- },
- {
- "$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetSku",
- "properties": {
- "name": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 1,
- "description": "The name of the SKU. Ex - P3. It is typically a letter+number code"
+ "description": "The type of identity that created the resource."
},
- "tier": {
+ "createdAt": {
"type": {
- "$ref": "#/45"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
+ "description": "The timestamp of resource creation (UTC)."
},
- "size": {
+ "lastModifiedBy": {
"type": {
"$ref": "#/2"
},
"flags": 0,
- "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
+ "description": "The identity that last modified the resource."
},
- "family": {
+ "lastModifiedByType": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/35"
},
"flags": 0,
- "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
+ "description": "The type of identity that last modified the resource."
},
- "capacity": {
+ "lastModifiedAt": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/2"
},
"flags": 0,
- "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
+ "description": "The timestamp of resource last modification (UTC)"
}
}
},
{
"$type": "StringLiteralType",
- "value": "Free"
+ "value": "User"
},
{
"$type": "StringLiteralType",
- "value": "Basic"
+ "value": "Application"
},
{
"$type": "StringLiteralType",
- "value": "Standard"
+ "value": "ManagedIdentity"
},
{
"$type": "StringLiteralType",
- "value": "Premium"
+ "value": "Key"
},
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/41"
+ "$ref": "#/26"
},
{
- "$ref": "#/42"
+ "$ref": "#/27"
},
{
- "$ref": "#/43"
+ "$ref": "#/28"
+ },
+ {
+ "$ref": "#/29"
},
{
- "$ref": "#/44"
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "User"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Application"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ManagedIdentity"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Key"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/31"
+ },
+ {
+ "$ref": "#/32"
+ },
+ {
+ "$ref": "#/33"
+ },
+ {
+ "$ref": "#/34"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/11"
+ }
+ },
+ {
+ "$type": "StringType",
+ "pattern": "^[-\\w\\._,\\(\\)]+$"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 2,
+ "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 2,
+ "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": {
+ "$ref": "#/44"
+ },
+ "flags": 1,
+ "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)."
+ },
+ "userAssignedIdentities": {
+ "type": {
+ "$ref": "#/46"
+ },
+ "flags": 0,
+ "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests."
+ }
+ }
+ },
+ {
+ "$type": "StringType",
+ "minLength": 36,
+ "maxLength": 36,
+ "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "None"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "UserAssigned"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "SystemAssigned,UserAssigned"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/40"
+ },
+ {
+ "$ref": "#/41"
+ },
+ {
+ "$ref": "#/42"
+ },
+ {
+ "$ref": "#/43"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "UserAssignedIdentity",
+ "properties": {
+ "principalId": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 2,
+ "description": "The principal ID of the assigned identity."
+ },
+ "clientId": {
+ "type": {
+ "$ref": "#/39"
+ },
+ "flags": 2,
+ "description": "The client ID of the assigned identity."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ManagedServiceIdentityUserAssignedIdentities",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/45"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Sku",
+ "properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The name of the SKU. E.g. P3. It is typically a letter+number code"
+ },
+ "tier": {
+ "type": {
+ "$ref": "#/52"
+ },
+ "flags": 0,
+ "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
+ },
+ "size": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
+ },
+ "family": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
+ },
+ "capacity": {
+ "type": {
+ "$ref": "#/53"
+ },
+ "flags": 0,
+ "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Free"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Basic"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/48"
+ },
+ {
+ "$ref": "#/49"
+ },
+ {
+ "$ref": "#/50"
+ },
+ {
+ "$ref": "#/51"
}
]
},
@@ -616,7 +705,7 @@
},
{
"$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetPlan",
+ "name": "Plan",
"properties": {
"name": {
"type": {
@@ -655,9 +744,17 @@
}
}
},
+ {
+ "$type": "ObjectType",
+ "name": "TrackedResourceTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/workspaces@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/workspaces@2024-11-01-preview",
"scopeType": 8,
"body": {
"$ref": "#/4"
@@ -670,7 +767,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -692,40 +789,40 @@
},
"type": {
"type": {
- "$ref": "#/49"
+ "$ref": "#/57"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/50"
+ "$ref": "#/58"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/23"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Resource properties."
},
"systemData": {
"type": {
- "$ref": "#/5"
+ "$ref": "#/25"
},
"flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/51"
+ "$ref": "#/59"
},
"flags": 0
},
@@ -735,7 +832,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -757,40 +854,40 @@
},
"type": {
"type": {
- "$ref": "#/53"
+ "$ref": "#/61"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/54"
+ "$ref": "#/62"
},
"flags": 10,
"description": "The resource api version"
},
"properties": {
"type": {
- "$ref": "#/23"
+ "$ref": "#/12"
},
"flags": 0,
"description": "Resource properties."
},
"systemData": {
"type": {
- "$ref": "#/5"
+ "$ref": "#/25"
},
"flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/55"
+ "$ref": "#/63"
},
"flags": 0
},
@@ -800,7 +897,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -822,39 +919,25 @@
},
"type": {
"type": {
- "$ref": "#/57"
+ "$ref": "#/65"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/58"
+ "$ref": "#/66"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/60"
+ "$ref": "#/68"
},
"flags": 1,
"description": "Detailed properties for scaling plan."
},
- "location": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The geo-location where the resource lives"
- },
"managedBy": {
"type": {
"$ref": "#/2"
@@ -864,10 +947,10 @@
},
"kind": {
"type": {
- "$ref": "#/36"
+ "$ref": "#/37"
},
"flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
"etag": {
"type": {
@@ -876,43 +959,60 @@
"flags": 2,
"description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- "tags": {
- "type": {
- "$ref": "#/96"
- },
- "flags": 0,
- "description": "Resource tags."
- },
"identity": {
"type": {
"$ref": "#/38"
},
- "flags": 0
+ "flags": 0,
+ "description": "Managed service identity (system assigned and/or user assigned identities)"
},
"sku": {
"type": {
- "$ref": "#/40"
+ "$ref": "#/47"
},
- "flags": 0
+ "flags": 0,
+ "description": "The resource model definition representing SKU"
},
"plan": {
"type": {
- "$ref": "#/47"
+ "$ref": "#/54"
},
- "flags": 0
- }
- }
- },
- {
- "$type": "ObjectType",
- "name": "ScalingPlanProperties",
- "properties": {
- "objectId": {
+ "flags": 0,
+ "description": "Plan for the resource."
+ },
+ "tags": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/110"
},
- "flags": 2,
- "description": "ObjectId of scaling plan. (internal use)"
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ScalingPlanProperties",
+ "properties": {
+ "objectId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "ObjectId of scaling plan. (internal use)"
},
"description": {
"type": {
@@ -937,7 +1037,7 @@
},
"hostPoolType": {
"type": {
- "$ref": "#/62"
+ "$ref": "#/71"
},
"flags": 0,
"description": "HostPool type for desktop."
@@ -951,14 +1051,14 @@
},
"schedules": {
"type": {
- "$ref": "#/93"
+ "$ref": "#/107"
},
"flags": 0,
- "description": "List of ScalingPlanPooledSchedule definitions."
+ "description": "List of Pooled ScalingSchedule definitions."
},
"hostPoolReferences": {
"type": {
- "$ref": "#/95"
+ "$ref": "#/109"
},
"flags": 0,
"description": "List of ScalingHostPoolReference definitions."
@@ -969,11 +1069,18 @@
"$type": "StringLiteralType",
"value": "Pooled"
},
+ {
+ "$type": "StringLiteralType",
+ "value": "Personal"
+ },
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/61"
+ "$ref": "#/69"
+ },
+ {
+ "$ref": "#/70"
},
{
"$ref": "#/2"
@@ -993,98 +1100,112 @@
},
"daysOfWeek": {
"type": {
- "$ref": "#/72"
+ "$ref": "#/81"
},
"flags": 0,
"description": "Set of days of the week on which this schedule is active."
},
+ "scalingMethod": {
+ "type": {
+ "$ref": "#/84"
+ },
+ "flags": 0,
+ "description": "The desired scaling method to be used to scale the hosts in the assigned host pool."
+ },
+ "createDelete": {
+ "type": {
+ "$ref": "#/85"
+ },
+ "flags": 0,
+ "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts."
+ },
"rampUpStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
"flags": 0,
"description": "Starting time for ramp up period."
},
"rampUpLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/78"
+ "$ref": "#/92"
},
"flags": 0,
"description": "Load balancing algorithm for ramp up period."
},
"rampUpMinimumHostsPct": {
"type": {
- "$ref": "#/79"
+ "$ref": "#/93"
},
"flags": 0,
"description": "Minimum host percentage for ramp up period."
},
"rampUpCapacityThresholdPct": {
"type": {
- "$ref": "#/80"
+ "$ref": "#/94"
},
"flags": 0,
"description": "Capacity threshold for ramp up period."
},
"peakStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
"flags": 0,
"description": "Starting time for peak period."
},
"peakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/83"
+ "$ref": "#/97"
},
"flags": 0,
"description": "Load balancing algorithm for peak period."
},
"rampDownStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
"flags": 0,
"description": "Starting time for ramp down period."
},
"rampDownLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/86"
+ "$ref": "#/100"
},
"flags": 0,
"description": "Load balancing algorithm for ramp down period."
},
"rampDownMinimumHostsPct": {
"type": {
- "$ref": "#/79"
+ "$ref": "#/93"
},
"flags": 0,
"description": "Minimum host percentage for ramp down period."
},
"rampDownCapacityThresholdPct": {
"type": {
- "$ref": "#/79"
+ "$ref": "#/94"
},
"flags": 0,
"description": "Capacity threshold for ramp down period."
},
"rampDownForceLogoffUsers": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Should users be logged off forcefully from hosts."
},
"rampDownStopHostsWhen": {
"type": {
- "$ref": "#/89"
+ "$ref": "#/103"
},
"flags": 0,
"description": "Specifies when to stop hosts during ramp down period."
},
"rampDownWaitTimeMinutes": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/53"
},
"flags": 0,
"description": "Number of minutes to wait to stop hosts during ramp down period."
@@ -1098,24 +1219,20 @@
},
"offPeakStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
"flags": 0,
"description": "Starting time for off-peak period."
},
"offPeakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/92"
+ "$ref": "#/106"
},
"flags": 0,
"description": "Load balancing algorithm for off-peak period."
}
}
},
- {
- "$type": "StringLiteralType",
- "value": "Sunday"
- },
{
"$type": "StringLiteralType",
"value": "Monday"
@@ -1140,29 +1257,58 @@
"$type": "StringLiteralType",
"value": "Saturday"
},
+ {
+ "$type": "StringLiteralType",
+ "value": "Sunday"
+ },
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/64"
+ "$ref": "#/73"
+ },
+ {
+ "$ref": "#/74"
},
{
- "$ref": "#/65"
+ "$ref": "#/75"
},
{
- "$ref": "#/66"
+ "$ref": "#/76"
},
{
- "$ref": "#/67"
+ "$ref": "#/77"
},
{
- "$ref": "#/68"
+ "$ref": "#/78"
},
{
- "$ref": "#/69"
+ "$ref": "#/79"
+ }
+ ]
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/80"
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "PowerManage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateDeletePowerManage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/82"
},
{
- "$ref": "#/70"
+ "$ref": "#/83"
},
{
"$ref": "#/2"
@@ -1170,25 +1316,62 @@
]
},
{
- "$type": "ArrayType",
- "itemType": {
- "$ref": "#/71"
+ "$type": "ObjectType",
+ "name": "CreateDeleteProperties",
+ "properties": {
+ "rampUpMaximumHostPoolSize": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 0,
+ "description": "Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property."
+ },
+ "rampUpMinimumHostPoolSize": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property."
+ },
+ "rampDownMaximumHostPoolSize": {
+ "type": {
+ "$ref": "#/86"
+ },
+ "flags": 0,
+ "description": "Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property."
+ },
+ "rampDownMinimumHostPoolSize": {
+ "type": {
+ "$ref": "#/87"
+ },
+ "flags": 0,
+ "description": "Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property."
+ }
}
},
+ {
+ "$type": "IntegerType",
+ "minValue": 0
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 0,
+ "maxValue": 59
+ },
{
"$type": "ObjectType",
"name": "Time",
"properties": {
"hour": {
"type": {
- "$ref": "#/74"
+ "$ref": "#/89"
},
"flags": 1,
"description": "The hour."
},
"minute": {
"type": {
- "$ref": "#/75"
+ "$ref": "#/87"
},
"flags": 1,
"description": "The minute."
@@ -1200,11 +1383,6 @@
"minValue": 0,
"maxValue": 23
},
- {
- "$type": "IntegerType",
- "minValue": 0,
- "maxValue": 59
- },
{
"$type": "StringLiteralType",
"value": "BreadthFirst"
@@ -1217,10 +1395,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/76"
+ "$ref": "#/90"
},
{
- "$ref": "#/77"
+ "$ref": "#/91"
},
{
"$ref": "#/2"
@@ -1249,10 +1427,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/81"
+ "$ref": "#/95"
},
{
- "$ref": "#/82"
+ "$ref": "#/96"
},
{
"$ref": "#/2"
@@ -1271,10 +1449,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/84"
+ "$ref": "#/98"
},
{
- "$ref": "#/85"
+ "$ref": "#/99"
},
{
"$ref": "#/2"
@@ -1293,10 +1471,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/87"
+ "$ref": "#/101"
},
{
- "$ref": "#/88"
+ "$ref": "#/102"
},
{
"$ref": "#/2"
@@ -1315,10 +1493,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/90"
+ "$ref": "#/104"
},
{
- "$ref": "#/91"
+ "$ref": "#/105"
},
{
"$ref": "#/2"
@@ -1328,7 +1506,7 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/63"
+ "$ref": "#/72"
}
},
{
@@ -1344,7 +1522,7 @@
},
"scalingPlanEnabled": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Is the scaling plan enabled for this hostpool."
@@ -1354,12 +1532,12 @@
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/94"
+ "$ref": "#/108"
}
},
{
"$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetTags",
+ "name": "TrackedResourceTags",
"properties": {},
"additionalProperties": {
"$ref": "#/2"
@@ -1367,17 +1545,18 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/59"
+ "$ref": "#/67"
},
"flags": 0
},
{
"$type": "StringType",
"minLength": 1,
- "maxLength": 64
+ "maxLength": 64,
+ "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
},
{
"$type": "StringLiteralType",
@@ -1385,7 +1564,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -1400,38 +1579,38 @@
},
"name": {
"type": {
- "$ref": "#/98"
+ "$ref": "#/112"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/99"
+ "$ref": "#/113"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/100"
+ "$ref": "#/114"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/102"
+ "$ref": "#/116"
},
"flags": 1,
"description": "Detailed properties for ScalingPlanPooledSchedule"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
@@ -1439,100 +1618,121 @@
"$type": "ObjectType",
"name": "ScalingPlanPooledScheduleProperties",
"properties": {
+ "name": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 2,
+ "description": "Name of the ScalingPlanPooledSchedule."
+ },
"daysOfWeek": {
"type": {
- "$ref": "#/111"
+ "$ref": "#/125"
},
- "flags": 0,
+ "flags": 1,
"description": "Set of days of the week on which this schedule is active."
},
- "rampUpStartTime": {
+ "scalingMethod": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/128"
+ },
+ "flags": 0,
+ "description": "The desired scaling method to be used to scale the hosts in the assigned host pool."
+ },
+ "createDelete": {
+ "type": {
+ "$ref": "#/85"
},
"flags": 0,
+ "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts."
+ },
+ "rampUpStartTime": {
+ "type": {
+ "$ref": "#/88"
+ },
+ "flags": 1,
"description": "Starting time for ramp up period."
},
"rampUpLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/114"
+ "$ref": "#/131"
},
"flags": 0,
"description": "Load balancing algorithm for ramp up period."
},
"rampUpMinimumHostsPct": {
"type": {
- "$ref": "#/79"
+ "$ref": "#/93"
},
"flags": 0,
"description": "Minimum host percentage for ramp up period."
},
"rampUpCapacityThresholdPct": {
"type": {
- "$ref": "#/80"
+ "$ref": "#/94"
},
- "flags": 0,
+ "flags": 1,
"description": "Capacity threshold for ramp up period."
},
"peakStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for peak period."
},
"peakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/117"
+ "$ref": "#/134"
},
"flags": 0,
"description": "Load balancing algorithm for peak period."
},
"rampDownStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for ramp down period."
},
"rampDownLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/120"
+ "$ref": "#/137"
},
"flags": 0,
"description": "Load balancing algorithm for ramp down period."
},
"rampDownMinimumHostsPct": {
"type": {
- "$ref": "#/79"
+ "$ref": "#/93"
},
"flags": 0,
"description": "Minimum host percentage for ramp down period."
},
"rampDownCapacityThresholdPct": {
"type": {
- "$ref": "#/79"
+ "$ref": "#/94"
},
- "flags": 0,
+ "flags": 1,
"description": "Capacity threshold for ramp down period."
},
"rampDownForceLogoffUsers": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Should users be logged off forcefully from hosts."
},
"rampDownStopHostsWhen": {
"type": {
- "$ref": "#/123"
+ "$ref": "#/140"
},
"flags": 0,
"description": "Specifies when to stop hosts during ramp down period."
},
"rampDownWaitTimeMinutes": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/53"
},
"flags": 0,
"description": "Number of minutes to wait to stop hosts during ramp down period."
@@ -1546,14 +1746,14 @@
},
"offPeakStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for off-peak period."
},
"offPeakLoadBalancingAlgorithm": {
"type": {
- "$ref": "#/126"
+ "$ref": "#/143"
},
"flags": 0,
"description": "Load balancing algorithm for off-peak period."
@@ -1592,34 +1792,56 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/103"
+ "$ref": "#/117"
},
{
- "$ref": "#/104"
+ "$ref": "#/118"
},
{
- "$ref": "#/105"
+ "$ref": "#/119"
},
{
- "$ref": "#/106"
+ "$ref": "#/120"
},
{
- "$ref": "#/107"
+ "$ref": "#/121"
},
{
- "$ref": "#/108"
+ "$ref": "#/122"
},
{
- "$ref": "#/109"
+ "$ref": "#/123"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/110"
+ "$ref": "#/124"
}
},
+ {
+ "$type": "StringLiteralType",
+ "value": "PowerManage"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "CreateDeletePowerManage"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/126"
+ },
+ {
+ "$ref": "#/127"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
{
"$type": "StringLiteralType",
"value": "BreadthFirst"
@@ -1632,10 +1854,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/112"
+ "$ref": "#/129"
},
{
- "$ref": "#/113"
+ "$ref": "#/130"
},
{
"$ref": "#/2"
@@ -1654,10 +1876,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/115"
+ "$ref": "#/132"
},
{
- "$ref": "#/116"
+ "$ref": "#/133"
},
{
"$ref": "#/2"
@@ -1676,10 +1898,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/118"
+ "$ref": "#/135"
},
{
- "$ref": "#/119"
+ "$ref": "#/136"
},
{
"$ref": "#/2"
@@ -1698,10 +1920,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/121"
+ "$ref": "#/138"
},
{
- "$ref": "#/122"
+ "$ref": "#/139"
},
{
"$ref": "#/2"
@@ -1720,10 +1942,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/124"
+ "$ref": "#/141"
},
{
- "$ref": "#/125"
+ "$ref": "#/142"
},
{
"$ref": "#/2"
@@ -1732,10 +1954,10 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/101"
+ "$ref": "#/115"
},
"flags": 0
},
@@ -1745,7 +1967,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -1760,38 +1982,38 @@
},
"name": {
"type": {
- "$ref": "#/98"
+ "$ref": "#/112"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/128"
+ "$ref": "#/145"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/129"
+ "$ref": "#/146"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/131"
+ "$ref": "#/148"
},
"flags": 1,
"description": "Detailed properties for ScalingPlanPersonalSchedule"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
@@ -1801,182 +2023,182 @@
"properties": {
"daysOfWeek": {
"type": {
- "$ref": "#/140"
+ "$ref": "#/157"
},
- "flags": 0,
+ "flags": 1,
"description": "Set of days of the week on which this schedule is active."
},
"rampUpStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for ramp up period."
},
"rampUpAutoStartHosts": {
"type": {
- "$ref": "#/144"
+ "$ref": "#/161"
},
"flags": 0,
"description": "The desired startup behavior during the ramp up period for personal vms in the hostpool."
},
"rampUpStartVMOnConnect": {
"type": {
- "$ref": "#/147"
+ "$ref": "#/164"
},
"flags": 0,
"description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually."
},
"rampUpActionOnDisconnect": {
"type": {
- "$ref": "#/151"
+ "$ref": "#/168"
},
"flags": 0,
"description": "Action to be taken after a user disconnect during the ramp up period."
},
"rampUpMinutesToWaitOnDisconnect": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period."
},
"rampUpActionOnLogoff": {
"type": {
- "$ref": "#/156"
+ "$ref": "#/172"
},
"flags": 0,
"description": "Action to be taken after a logoff during the ramp up period."
},
"rampUpMinutesToWaitOnLogoff": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period."
},
"peakStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for peak period."
},
"peakStartVMOnConnect": {
"type": {
- "$ref": "#/159"
+ "$ref": "#/175"
},
"flags": 0,
"description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase."
},
"peakActionOnDisconnect": {
"type": {
- "$ref": "#/163"
+ "$ref": "#/179"
},
"flags": 0,
"description": "Action to be taken after a user disconnect during the peak period."
},
"peakMinutesToWaitOnDisconnect": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period."
},
"peakActionOnLogoff": {
"type": {
- "$ref": "#/167"
+ "$ref": "#/183"
},
"flags": 0,
"description": "Action to be taken after a logoff during the peak period."
},
"peakMinutesToWaitOnLogoff": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period."
},
"rampDownStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for ramp down period."
},
"rampDownStartVMOnConnect": {
"type": {
- "$ref": "#/170"
+ "$ref": "#/186"
},
"flags": 0,
"description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase."
},
"rampDownActionOnDisconnect": {
"type": {
- "$ref": "#/174"
+ "$ref": "#/190"
},
"flags": 0,
"description": "Action to be taken after a user disconnect during the ramp down period."
},
"rampDownMinutesToWaitOnDisconnect": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period."
},
"rampDownActionOnLogoff": {
"type": {
- "$ref": "#/178"
+ "$ref": "#/194"
},
"flags": 0,
"description": "Action to be taken after a logoff during the ramp down period."
},
"rampDownMinutesToWaitOnLogoff": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period."
},
"offPeakStartTime": {
"type": {
- "$ref": "#/73"
+ "$ref": "#/88"
},
- "flags": 0,
+ "flags": 1,
"description": "Starting time for off-peak period."
},
"offPeakStartVMOnConnect": {
"type": {
- "$ref": "#/181"
+ "$ref": "#/197"
},
"flags": 0,
"description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase."
},
"offPeakActionOnDisconnect": {
"type": {
- "$ref": "#/185"
+ "$ref": "#/201"
},
"flags": 0,
"description": "Action to be taken after a user disconnect during the off-peak period."
},
"offPeakMinutesToWaitOnDisconnect": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period."
},
"offPeakActionOnLogoff": {
"type": {
- "$ref": "#/189"
+ "$ref": "#/205"
},
"flags": 0,
"description": "Action to be taken after a logoff during the off-peak period."
},
"offPeakMinutesToWaitOnLogoff": {
"type": {
- "$ref": "#/152"
+ "$ref": "#/86"
},
"flags": 0,
"description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period."
@@ -2015,32 +2237,32 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/132"
+ "$ref": "#/149"
},
{
- "$ref": "#/133"
+ "$ref": "#/150"
},
{
- "$ref": "#/134"
+ "$ref": "#/151"
},
{
- "$ref": "#/135"
+ "$ref": "#/152"
},
{
- "$ref": "#/136"
+ "$ref": "#/153"
},
{
- "$ref": "#/137"
+ "$ref": "#/154"
},
{
- "$ref": "#/138"
+ "$ref": "#/155"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/139"
+ "$ref": "#/156"
}
},
{
@@ -2059,13 +2281,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/141"
+ "$ref": "#/158"
},
{
- "$ref": "#/142"
+ "$ref": "#/159"
},
{
- "$ref": "#/143"
+ "$ref": "#/160"
},
{
"$ref": "#/2"
@@ -2084,10 +2306,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/145"
+ "$ref": "#/162"
},
{
- "$ref": "#/146"
+ "$ref": "#/163"
},
{
"$ref": "#/2"
@@ -2110,23 +2332,19 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/148"
+ "$ref": "#/165"
},
{
- "$ref": "#/149"
+ "$ref": "#/166"
},
{
- "$ref": "#/150"
+ "$ref": "#/167"
},
{
"$ref": "#/2"
}
]
},
- {
- "$type": "IntegerType",
- "minValue": 0
- },
{
"$type": "StringLiteralType",
"value": "None"
@@ -2143,13 +2361,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/153"
+ "$ref": "#/169"
},
{
- "$ref": "#/154"
+ "$ref": "#/170"
},
{
- "$ref": "#/155"
+ "$ref": "#/171"
},
{
"$ref": "#/2"
@@ -2168,10 +2386,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/157"
+ "$ref": "#/173"
},
{
- "$ref": "#/158"
+ "$ref": "#/174"
},
{
"$ref": "#/2"
@@ -2194,13 +2412,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/160"
+ "$ref": "#/176"
},
{
- "$ref": "#/161"
+ "$ref": "#/177"
},
{
- "$ref": "#/162"
+ "$ref": "#/178"
},
{
"$ref": "#/2"
@@ -2223,13 +2441,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/164"
+ "$ref": "#/180"
},
{
- "$ref": "#/165"
+ "$ref": "#/181"
},
{
- "$ref": "#/166"
+ "$ref": "#/182"
},
{
"$ref": "#/2"
@@ -2248,10 +2466,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/168"
+ "$ref": "#/184"
},
{
- "$ref": "#/169"
+ "$ref": "#/185"
},
{
"$ref": "#/2"
@@ -2274,13 +2492,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/171"
+ "$ref": "#/187"
},
{
- "$ref": "#/172"
+ "$ref": "#/188"
},
{
- "$ref": "#/173"
+ "$ref": "#/189"
},
{
"$ref": "#/2"
@@ -2303,13 +2521,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/175"
+ "$ref": "#/191"
},
{
- "$ref": "#/176"
+ "$ref": "#/192"
},
{
- "$ref": "#/177"
+ "$ref": "#/193"
},
{
"$ref": "#/2"
@@ -2328,10 +2546,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/179"
+ "$ref": "#/195"
},
{
- "$ref": "#/180"
+ "$ref": "#/196"
},
{
"$ref": "#/2"
@@ -2354,13 +2572,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/182"
+ "$ref": "#/198"
},
{
- "$ref": "#/183"
+ "$ref": "#/199"
},
{
- "$ref": "#/184"
+ "$ref": "#/200"
},
{
"$ref": "#/2"
@@ -2383,13 +2601,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/186"
+ "$ref": "#/202"
},
{
- "$ref": "#/187"
+ "$ref": "#/203"
},
{
- "$ref": "#/188"
+ "$ref": "#/204"
},
{
"$ref": "#/2"
@@ -2398,10 +2616,10 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/130"
+ "$ref": "#/147"
},
"flags": 0
},
@@ -2411,7 +2629,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -2433,39 +2651,25 @@
},
"type": {
"type": {
- "$ref": "#/191"
+ "$ref": "#/207"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/192"
+ "$ref": "#/208"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/194"
+ "$ref": "#/210"
},
"flags": 1,
"description": "Detailed properties for ApplicationGroup"
},
- "location": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The geo-location where the resource lives"
- },
"managedBy": {
"type": {
"$ref": "#/2"
@@ -2475,10 +2679,10 @@
},
"kind": {
"type": {
- "$ref": "#/36"
+ "$ref": "#/37"
},
"flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
"etag": {
"type": {
@@ -2487,30 +2691,47 @@
"flags": 2,
"description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- "tags": {
- "type": {
- "$ref": "#/198"
- },
- "flags": 0,
- "description": "Resource tags."
- },
"identity": {
"type": {
"$ref": "#/38"
},
- "flags": 0
+ "flags": 0,
+ "description": "Managed service identity (system assigned and/or user assigned identities)"
},
"sku": {
"type": {
- "$ref": "#/40"
+ "$ref": "#/47"
},
- "flags": 0
+ "flags": 0,
+ "description": "The resource model definition representing SKU"
},
"plan": {
"type": {
- "$ref": "#/47"
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "Plan for the resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/214"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
},
- "flags": 0
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
@@ -2555,21 +2776,21 @@
},
"applicationGroupType": {
"type": {
- "$ref": "#/197"
+ "$ref": "#/213"
},
"flags": 1,
"description": "Resource Type of ApplicationGroup."
},
"cloudPcResource": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 2,
"description": "Is cloud pc resource."
},
"showInFeed": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Boolean representing whether the applicationGroup is show in the feed."
@@ -2588,10 +2809,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/195"
+ "$ref": "#/211"
},
{
- "$ref": "#/196"
+ "$ref": "#/212"
},
{
"$ref": "#/2"
@@ -2600,7 +2821,7 @@
},
{
"$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetTags",
+ "name": "TrackedResourceTags",
"properties": {},
"additionalProperties": {
"$ref": "#/2"
@@ -2608,17 +2829,18 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/applicationGroups@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/applicationGroups@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/193"
+ "$ref": "#/209"
},
"flags": 0
},
{
"$type": "StringType",
"minLength": 3,
- "maxLength": 24
+ "maxLength": 24,
+ "pattern": "^[A-Za-z0-9@.\\-_ ]*$"
},
{
"$type": "StringLiteralType",
@@ -2626,7 +2848,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -2641,38 +2863,38 @@
},
"name": {
"type": {
- "$ref": "#/200"
+ "$ref": "#/216"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/201"
+ "$ref": "#/217"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/202"
+ "$ref": "#/218"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/204"
+ "$ref": "#/220"
},
"flags": 1,
"description": "Detailed properties for Application"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
+ },
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
@@ -2724,14 +2946,14 @@
},
"applicationType": {
"type": {
- "$ref": "#/207"
+ "$ref": "#/223"
},
"flags": 0,
"description": "Resource Type of Application."
},
"commandLineSetting": {
"type": {
- "$ref": "#/211"
+ "$ref": "#/227"
},
"flags": 1,
"description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all."
@@ -2745,7 +2967,7 @@
},
"showInPortal": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Specifies whether to show the RemoteApp program in the RD Web Access server."
@@ -2759,7 +2981,7 @@
},
"iconIndex": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/53"
},
"flags": 0,
"description": "Index of the icon."
@@ -2773,7 +2995,7 @@
},
"iconContent": {
"type": {
- "$ref": "#/212"
+ "$ref": "#/228"
},
"flags": 2,
"description": "the icon a 64 bit string as a byte array."
@@ -2792,10 +3014,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/205"
+ "$ref": "#/221"
},
{
- "$ref": "#/206"
+ "$ref": "#/222"
},
{
"$ref": "#/2"
@@ -2818,13 +3040,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/208"
+ "$ref": "#/224"
},
{
- "$ref": "#/209"
+ "$ref": "#/225"
},
{
- "$ref": "#/210"
+ "$ref": "#/226"
},
{
"$ref": "#/2"
@@ -2836,10 +3058,10 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/applicationGroups/applications@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/applicationGroups/applications@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/203"
+ "$ref": "#/219"
},
"flags": 0
},
@@ -2849,7 +3071,7 @@
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
@@ -2871,39 +3093,25 @@
},
"type": {
"type": {
- "$ref": "#/214"
+ "$ref": "#/230"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/215"
+ "$ref": "#/231"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
- "type": {
- "$ref": "#/5"
- },
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
- },
"properties": {
"type": {
- "$ref": "#/217"
+ "$ref": "#/233"
},
"flags": 1,
"description": "Detailed properties for HostPool"
},
- "location": {
- "type": {
- "$ref": "#/2"
- },
- "flags": 0,
- "description": "The geo-location where the resource lives"
- },
"managedBy": {
"type": {
"$ref": "#/2"
@@ -2913,10 +3121,10 @@
},
"kind": {
"type": {
- "$ref": "#/36"
+ "$ref": "#/37"
},
"flags": 0,
- "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value."
},
"etag": {
"type": {
@@ -2925,30 +3133,47 @@
"flags": 2,
"description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields."
},
- "tags": {
- "type": {
- "$ref": "#/264"
- },
- "flags": 0,
- "description": "Resource tags."
- },
"identity": {
"type": {
"$ref": "#/38"
},
- "flags": 0
+ "flags": 0,
+ "description": "Managed service identity (system assigned and/or user assigned identities)"
},
"sku": {
"type": {
- "$ref": "#/40"
+ "$ref": "#/47"
},
- "flags": 0
+ "flags": 0,
+ "description": "The resource model definition representing SKU"
},
"plan": {
"type": {
- "$ref": "#/47"
+ "$ref": "#/54"
+ },
+ "flags": 0,
+ "description": "Plan for the resource."
+ },
+ "tags": {
+ "type": {
+ "$ref": "#/301"
+ },
+ "flags": 0,
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The geo-location where the resource lives"
+ },
+ "systemData": {
+ "type": {
+ "$ref": "#/25"
},
- "flags": 0
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
@@ -2979,14 +3204,14 @@
},
"hostPoolType": {
"type": {
- "$ref": "#/221"
+ "$ref": "#/237"
},
"flags": 1,
"description": "HostPool type for desktop."
},
"personalDesktopAssignmentType": {
"type": {
- "$ref": "#/224"
+ "$ref": "#/240"
},
"flags": 0,
"description": "PersonalDesktopAssignment type for HostPool."
@@ -3000,38 +3225,38 @@
},
"maxSessionLimit": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/53"
},
"flags": 0,
"description": "The max session limit of HostPool."
},
"loadBalancerType": {
"type": {
- "$ref": "#/228"
+ "$ref": "#/245"
},
"flags": 1,
"description": "The type of the load balancer."
},
"ring": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/53"
},
"flags": 0,
"description": "The ring number of HostPool."
},
"validationEnvironment": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Is validation environment."
},
"registrationInfo": {
"type": {
- "$ref": "#/229"
+ "$ref": "#/246"
},
"flags": 0,
- "description": "The registration info of HostPool."
+ "description": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
},
"vmTemplate": {
"type": {
@@ -3040,13 +3265,27 @@
"flags": 0,
"description": "VM template for sessionhosts configuration within hostpool."
},
+ "managementType": {
+ "type": {
+ "$ref": "#/253"
+ },
+ "flags": 0,
+ "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated."
+ },
"applicationGroupReferences": {
"type": {
- "$ref": "#/234"
+ "$ref": "#/254"
},
"flags": 2,
"description": "List of applicationGroup links."
},
+ "appAttachPackageReferences": {
+ "type": {
+ "$ref": "#/255"
+ },
+ "flags": 2,
+ "description": "List of App Attach Package links."
+ },
"ssoadfsAuthority": {
"type": {
"$ref": "#/2"
@@ -3070,52 +3309,80 @@
},
"ssoSecretType": {
"type": {
- "$ref": "#/239"
+ "$ref": "#/260"
},
"flags": 0,
"description": "The type of single sign on Secret Type."
},
"preferredAppGroupType": {
"type": {
- "$ref": "#/243"
+ "$ref": "#/264"
},
"flags": 1,
"description": "The type of preferred application group type, default to Desktop Application Group"
},
"startVMOnConnect": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "The flag to turn on/off StartVMOnConnect feature."
},
"cloudPcResource": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 2,
"description": "Is cloud pc resource."
},
"publicNetworkAccess": {
"type": {
- "$ref": "#/248"
+ "$ref": "#/269"
},
"flags": 0,
"description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints"
},
"agentUpdate": {
"type": {
- "$ref": "#/249"
+ "$ref": "#/270"
},
"flags": 0,
"description": "The session host configuration for updating agent, monitoring agent, and stack component."
},
"privateEndpointConnections": {
"type": {
- "$ref": "#/263"
+ "$ref": "#/284"
},
"flags": 2,
"description": "List of private endpoint connection associated with the specified resource"
+ },
+ "managedPrivateUDP": {
+ "type": {
+ "$ref": "#/288"
+ },
+ "flags": 0,
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ },
+ "directUDP": {
+ "type": {
+ "$ref": "#/292"
+ },
+ "flags": 0,
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ },
+ "publicUDP": {
+ "type": {
+ "$ref": "#/296"
+ },
+ "flags": 0,
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
+ },
+ "relayUDP": {
+ "type": {
+ "$ref": "#/300"
+ },
+ "flags": 0,
+ "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections"
}
}
},
@@ -3135,13 +3402,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/218"
+ "$ref": "#/234"
},
{
- "$ref": "#/219"
+ "$ref": "#/235"
},
{
- "$ref": "#/220"
+ "$ref": "#/236"
},
{
"$ref": "#/2"
@@ -3160,10 +3427,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/222"
+ "$ref": "#/238"
},
{
- "$ref": "#/223"
+ "$ref": "#/239"
},
{
"$ref": "#/2"
@@ -3182,17 +3449,24 @@
"$type": "StringLiteralType",
"value": "Persistent"
},
+ {
+ "$type": "StringLiteralType",
+ "value": "MultiplePersistent"
+ },
{
"$type": "UnionType",
"elements": [
{
- "$ref": "#/225"
+ "$ref": "#/241"
},
{
- "$ref": "#/226"
+ "$ref": "#/242"
+ },
+ {
+ "$ref": "#/243"
},
{
- "$ref": "#/227"
+ "$ref": "#/244"
},
{
"$ref": "#/2"
@@ -3219,7 +3493,7 @@
},
"registrationTokenOperation": {
"type": {
- "$ref": "#/233"
+ "$ref": "#/250"
},
"flags": 0,
"description": "The type of resetting the token."
@@ -3242,13 +3516,35 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/230"
+ "$ref": "#/247"
+ },
+ {
+ "$ref": "#/248"
+ },
+ {
+ "$ref": "#/249"
},
{
- "$ref": "#/231"
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Automated"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/251"
},
{
- "$ref": "#/232"
+ "$ref": "#/252"
},
{
"$ref": "#/2"
@@ -3261,6 +3557,12 @@
"$ref": "#/2"
}
},
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/2"
+ }
+ },
{
"$type": "StringLiteralType",
"value": "SharedKey"
@@ -3281,16 +3583,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/235"
+ "$ref": "#/256"
},
{
- "$ref": "#/236"
+ "$ref": "#/257"
},
{
- "$ref": "#/237"
+ "$ref": "#/258"
},
{
- "$ref": "#/238"
+ "$ref": "#/259"
},
{
"$ref": "#/2"
@@ -3313,13 +3615,13 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/240"
+ "$ref": "#/261"
},
{
- "$ref": "#/241"
+ "$ref": "#/262"
},
{
- "$ref": "#/242"
+ "$ref": "#/263"
},
{
"$ref": "#/2"
@@ -3346,16 +3648,16 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/244"
+ "$ref": "#/265"
},
{
- "$ref": "#/245"
+ "$ref": "#/266"
},
{
- "$ref": "#/246"
+ "$ref": "#/267"
},
{
- "$ref": "#/247"
+ "$ref": "#/268"
},
{
"$ref": "#/2"
@@ -3368,14 +3670,14 @@
"properties": {
"type": {
"type": {
- "$ref": "#/252"
+ "$ref": "#/273"
},
"flags": 0,
"description": "The type of maintenance for session host components."
},
"useSessionHostLocalTime": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/7"
},
"flags": 0,
"description": "Whether to use localTime of the virtual machine."
@@ -3389,7 +3691,7 @@
},
"maintenanceWindows": {
"type": {
- "$ref": "#/262"
+ "$ref": "#/283"
},
"flags": 0,
"description": "List of maintenance windows. Maintenance windows are 2 hours long."
@@ -3408,10 +3710,10 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/250"
+ "$ref": "#/271"
},
{
- "$ref": "#/251"
+ "$ref": "#/272"
},
{
"$ref": "#/2"
@@ -3424,14 +3726,14 @@
"properties": {
"hour": {
"type": {
- "$ref": "#/46"
+ "$ref": "#/53"
},
"flags": 0,
"description": "The update start hour of the day. (0 - 23)"
},
"dayOfWeek": {
"type": {
- "$ref": "#/261"
+ "$ref": "#/282"
},
"flags": 0,
"description": "Day of the week."
@@ -3470,43 +3772,159 @@
"$type": "UnionType",
"elements": [
{
- "$ref": "#/254"
+ "$ref": "#/275"
},
{
- "$ref": "#/255"
+ "$ref": "#/276"
},
{
- "$ref": "#/256"
+ "$ref": "#/277"
},
{
- "$ref": "#/257"
+ "$ref": "#/278"
},
{
- "$ref": "#/258"
+ "$ref": "#/279"
},
{
- "$ref": "#/259"
+ "$ref": "#/280"
},
{
- "$ref": "#/260"
+ "$ref": "#/281"
}
]
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/253"
+ "$ref": "#/274"
}
},
{
"$type": "ArrayType",
"itemType": {
- "$ref": "#/22"
+ "$ref": "#/11"
}
},
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/285"
+ },
+ {
+ "$ref": "#/286"
+ },
+ {
+ "$ref": "#/287"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/289"
+ },
+ {
+ "$ref": "#/290"
+ },
+ {
+ "$ref": "#/291"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/293"
+ },
+ {
+ "$ref": "#/294"
+ },
+ {
+ "$ref": "#/295"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Enabled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Disabled"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/297"
+ },
+ {
+ "$ref": "#/298"
+ },
+ {
+ "$ref": "#/299"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
{
"$type": "ObjectType",
- "name": "ResourceModelWithAllowedPropertySetTags",
+ "name": "TrackedResourceTags",
"properties": {},
"additionalProperties": {
"$ref": "#/2"
@@ -3514,29 +3932,28 @@
},
{
"$type": "ResourceType",
- "name": "Microsoft.DesktopVirtualization/hostPools@2023-07-07-preview",
+ "name": "Microsoft.DesktopVirtualization/hostPools@2024-11-01-preview",
"scopeType": 8,
"body": {
- "$ref": "#/216"
+ "$ref": "#/232"
},
"flags": 0
},
{
- "$type": "StringType",
- "minLength": 3,
- "maxLength": 100
+ "$type": "StringLiteralType",
+ "value": "default"
},
{
"$type": "StringLiteralType",
- "value": "Microsoft.DesktopVirtualization/hostPools/msixPackages"
+ "value": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements"
},
{
"$type": "StringLiteralType",
- "value": "2023-07-07-preview"
+ "value": "2024-11-01-preview"
},
{
"$type": "ObjectType",
- "name": "Microsoft.DesktopVirtualization/hostPools/msixPackages",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
"properties": {
"id": {
"type": {
@@ -3547,224 +3964,1326 @@
},
"name": {
"type": {
- "$ref": "#/266"
+ "$ref": "#/303"
},
"flags": 9,
"description": "The resource name"
},
"type": {
"type": {
- "$ref": "#/267"
+ "$ref": "#/304"
},
"flags": 10,
"description": "The resource type"
},
"apiVersion": {
"type": {
- "$ref": "#/268"
+ "$ref": "#/305"
},
"flags": 10,
"description": "The resource api version"
},
- "systemData": {
+ "properties": {
"type": {
- "$ref": "#/5"
+ "$ref": "#/307"
},
- "flags": 2,
- "description": "Metadata pertaining to creation and last modification of the resource."
+ "flags": 1,
+ "description": "Detailed properties for SessionHostManagement"
},
- "properties": {
+ "systemData": {
"type": {
- "$ref": "#/270"
+ "$ref": "#/25"
},
- "flags": 1,
- "description": "Detailed properties for MSIX Package"
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
{
"$type": "ObjectType",
- "name": "MsixPackageProperties",
+ "name": "SessionHostManagementProperties",
"properties": {
- "imagePath": {
+ "scheduledDateTimeZone": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "VHD/CIM image path on Network Share."
+ "flags": 1,
+ "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true."
},
- "packageName": {
+ "update": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/308"
},
- "flags": 0,
- "description": "Package Name from appxmanifest.xml."
- },
- "packageFamilyName": {
+ "flags": 1,
+ "description": "Parameters for a hostpool update."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "HostPoolUpdateConfigurationProperties",
+ "properties": {
+ "deleteOriginalVm": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/7"
},
"flags": 0,
- "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name."
+ "description": "Whether not to save original disk. False by default."
},
- "displayName": {
+ "maxVmsRemoved": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/309"
},
- "flags": 0,
- "description": "User friendly Name to be displayed in the portal."
+ "flags": 1,
+ "description": "The maximum number of virtual machines to be removed during hostpool update."
},
- "packageRelativePath": {
+ "logOffDelayMinutes": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/53"
},
- "flags": 0,
- "description": "Relative Path to the package inside the image."
+ "flags": 1,
+ "description": "Grace period before logging off users in minutes."
},
- "isRegularRegistration": {
+ "logOffMessage": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/310"
},
"flags": 0,
- "description": "Specifies how to register Package in feed."
+ "description": "Log off message sent to user for logoff. Default value is an empty string."
+ }
+ }
+ },
+ {
+ "$type": "IntegerType",
+ "minValue": 1
+ },
+ {
+ "$type": "StringType",
+ "maxLength": 260
+ },
+ {
+ "$type": "ResourceType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements@2024-11-01-preview",
+ "scopeType": 8,
+ "body": {
+ "$ref": "#/306"
+ },
+ "flags": 0
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "default"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "2024-11-01-preview"
+ },
+ {
+ "$type": "ObjectType",
+ "name": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations",
+ "properties": {
+ "id": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 10,
+ "description": "The resource id"
},
- "isActive": {
+ "name": {
"type": {
- "$ref": "#/18"
+ "$ref": "#/312"
},
- "flags": 0,
- "description": "Make this version of the package the active one across the hostpool."
+ "flags": 9,
+ "description": "The resource name"
},
- "packageDependencies": {
+ "type": {
"type": {
- "$ref": "#/272"
+ "$ref": "#/313"
},
- "flags": 0,
- "description": "List of package dependencies."
+ "flags": 10,
+ "description": "The resource type"
},
- "version": {
+ "apiVersion": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/314"
},
- "flags": 0,
- "description": "Package Version found in the appxmanifest.xml."
+ "flags": 10,
+ "description": "The resource api version"
},
- "lastUpdated": {
+ "properties": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/316"
},
- "flags": 0,
- "description": "Date Package was last updated, found in the appxmanifest.xml."
+ "flags": 1,
+ "description": "Detailed properties for SessionHostConfiguration"
},
- "packageApplications": {
+ "systemData": {
"type": {
- "$ref": "#/274"
+ "$ref": "#/25"
},
- "flags": 0,
- "description": "List of package applications."
+ "flags": 2,
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information."
}
}
},
{
"$type": "ObjectType",
- "name": "MsixPackageDependencies",
+ "name": "SessionHostConfigurationProperties",
"properties": {
- "dependencyName": {
+ "version": {
"type": {
"$ref": "#/2"
},
- "flags": 0,
- "description": "Name of package dependency."
+ "flags": 2,
+ "description": "The timestamp of the last update."
},
- "publisher": {
+ "friendlyName": {
"type": {
- "$ref": "#/2"
+ "$ref": "#/310"
},
"flags": 0,
- "description": "Name of dependency publisher."
+ "description": "Friendly name to describe this version of the SessionHostConfiguration."
},
- "minVersion": {
+ "provisioningState": {
+ "type": {
+ "$ref": "#/321"
+ },
+ "flags": 2,
+ "description": "Provisioning state of the Session Host Configuration."
+ },
+ "vmTags": {
+ "type": {
+ "$ref": "#/322"
+ },
+ "flags": 0,
+ "description": "Hashtable that lists key/value pair tags to apply to the VMs"
+ },
+ "vmLocation": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
+ },
+ "vmResourceGroup": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided."
+ },
+ "vmNamePrefix": {
+ "type": {
+ "$ref": "#/323"
+ },
+ "flags": 1,
+ "description": "The prefix that should be associated with session host names"
+ },
+ "availabilityZones": {
+ "type": {
+ "$ref": "#/324"
+ },
+ "flags": 0,
+ "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]."
+ },
+ "networkInfo": {
+ "type": {
+ "$ref": "#/325"
+ },
+ "flags": 1,
+ "description": "Network information."
+ },
+ "vmSizeId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6"
+ },
+ "diskInfo": {
+ "type": {
+ "$ref": "#/326"
+ },
+ "flags": 1,
+ "description": "Disk information."
+ },
+ "customConfigurationScriptUrl": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning."
+ },
+ "imageInfo": {
+ "type": {
+ "$ref": "#/331"
+ },
+ "flags": 1,
+ "description": "Image configurations of HostPool."
+ },
+ "domainInfo": {
+ "type": {
+ "$ref": "#/337"
+ },
+ "flags": 1,
+ "description": "Domain configurations of session hosts."
+ },
+ "securityInfo": {
+ "type": {
+ "$ref": "#/344"
+ },
+ "flags": 0,
+ "description": "Security information."
+ },
+ "vmAdminCredentials": {
+ "type": {
+ "$ref": "#/342"
+ },
+ "flags": 1,
+ "description": "Local Admin credentials for session hosts."
+ },
+ "bootDiagnosticsInfo": {
+ "type": {
+ "$ref": "#/349"
+ },
+ "flags": 0,
+ "description": "Boot Diagnostics information."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Succeeded"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Failed"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Canceled"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Provisioning"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/317"
+ },
+ {
+ "$ref": "#/318"
+ },
+ {
+ "$ref": "#/319"
+ },
+ {
+ "$ref": "#/320"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SessionHostConfigurationPropertiesVmTags",
+ "properties": {},
+ "additionalProperties": {
+ "$ref": "#/2"
+ }
+ },
+ {
+ "$type": "StringType",
+ "maxLength": 11
+ },
+ {
+ "$type": "ArrayType",
+ "itemType": {
+ "$ref": "#/53"
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "NetworkInfoProperties",
+ "properties": {
+ "subnetId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource ID of the subnet."
+ },
+ "securityGroupId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DiskInfoProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/330"
+ },
+ "flags": 1,
+ "description": "The disk type used by virtual machine in hostpool session host."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Premium_LRS"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "StandardSSD_LRS"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/327"
+ },
+ {
+ "$ref": "#/328"
+ },
+ {
+ "$ref": "#/329"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ImageInfoProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/334"
+ },
+ "flags": 1,
+ "description": "The type of image session hosts use in the hostpool."
+ },
+ "marketplaceInfo": {
+ "type": {
+ "$ref": "#/335"
+ },
+ "flags": 0,
+ "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type."
+ },
+ "customInfo": {
+ "type": {
+ "$ref": "#/336"
+ },
+ "flags": 0,
+ "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Marketplace"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Custom"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/332"
+ },
+ {
+ "$ref": "#/333"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "MarketplaceInfoProperties",
+ "properties": {
+ "offer": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The offer of the image."
+ },
+ "publisher": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The publisher of the image."
+ },
+ "sku": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The sku of the image."
+ },
+ "exactVersion": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The exact version of the image."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "CustomInfoProperties",
+ "properties": {
+ "resourceId": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The resource id of the custom image."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "DomainInfoProperties",
+ "properties": {
+ "joinType": {
+ "type": {
+ "$ref": "#/340"
+ },
+ "flags": 1,
+ "description": "The type of domain join done by the virtual machine."
+ },
+ "activeDirectoryInfo": {
+ "type": {
+ "$ref": "#/341"
+ },
+ "flags": 0,
+ "description": "Active directory info. Only one should be populated based on the join type."
+ },
+ "azureActiveDirectoryInfo": {
+ "type": {
+ "$ref": "#/343"
+ },
+ "flags": 0,
+ "description": "Azure active directory info. Only one should be populated based on the join type."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ActiveDirectory"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "AzureActiveDirectory"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/338"
+ },
+ {
+ "$ref": "#/339"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "ActiveDirectoryInfoProperties",
+ "properties": {
+ "domainCredentials": {
+ "type": {
+ "$ref": "#/342"
+ },
+ "flags": 1,
+ "description": "Credentials needed to create the virtual machine."
+ },
+ "ouPath": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The organizational unit(OU) path."
+ },
+ "domainName": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "The domain a virtual machine connected to a hostpool will join."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "KeyVaultCredentialsProperties",
+ "properties": {
+ "usernameKeyVaultSecretUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The uri to access the secret that the username is stored in."
+ },
+ "passwordKeyVaultSecretUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The uri to access the secret that the password is stored in."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "AzureActiveDirectoryInfoProperties",
+ "properties": {
+ "mdmProviderGuid": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 1,
+ "description": "The Mobile Device Management(MDM) guid."
+ }
+ }
+ },
+ {
+ "$type": "ObjectType",
+ "name": "SecurityInfoProperties",
+ "properties": {
+ "type": {
+ "type": {
+ "$ref": "#/348"
+ },
+ "flags": 0,
+ "description": "The security type used by virtual machine in hostpool session host. Default is Standard."
+ },
+ "secureBootEnabled": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Whether to use secureBoot on the virtual machine."
+ },
+ "vTpmEnabled": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Whether to use vTPM on the virtual machine."
+ }
+ }
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "Standard"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "TrustedLaunch"
+ },
+ {
+ "$type": "StringLiteralType",
+ "value": "ConfidentialVM"
+ },
+ {
+ "$type": "UnionType",
+ "elements": [
+ {
+ "$ref": "#/345"
+ },
+ {
+ "$ref": "#/346"
+ },
+ {
+ "$ref": "#/347"
+ },
+ {
+ "$ref": "#/2"
+ }
+ ]
+ },
+ {
+ "$type": "ObjectType",
+ "name": "BootDiagnosticsInfoProperties",
+ "properties": {
+ "enabled": {
+ "type": {
+ "$ref": "#/7"
+ },
+ "flags": 0,
+ "description": "Whether boot diagnostics should be enabled on the Virtual Machine."
+ },
+ "storageUri": {
+ "type": {
+ "$ref": "#/2"
+ },
+ "flags": 0,
+ "description": "Uri of the storage account to use for placing the console output and screenshot.