fleets
Creates, updates, deletes, gets or lists a fleets resource.
Overview
| Name | fleets |
| Type | Resource |
| Id | azure.azure_fleet.fleets |
Fields
- vw_fleets
- fleets
| Name | Datatype | Description |
|---|---|---|
compute_profile | text | field from the properties object |
fleetName | text | field from the properties object |
identity | text | Managed service identity (system assigned and/or user assigned identities) |
location | text | The geo-location where the resource lives |
plan | text | Plan for the resource. |
provisioning_state | text | field from the properties object |
regular_priority_profile | text | field from the properties object |
resourceGroupName | text | field from the properties object |
spot_priority_profile | text | field from the properties object |
subscriptionId | text | field from the properties object |
tags | text | Resource tags. |
time_created | text | field from the properties object |
unique_id | text | field from the properties object |
vm_sizes_profile | text | field from the properties object |
zones | text | Zones in which the Compute Fleet is available |
| Name | Datatype | Description |
|---|---|---|
identity | object | Managed service identity (system assigned and/or user assigned identities) |
location | string | The geo-location where the resource lives |
plan | object | Plan for the resource. |
properties | object | Details of the Compute Fleet. |
tags | object | Resource tags. |
zones | array | Zones in which the Compute Fleet is available |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | fleetName, resourceGroupName, subscriptionId | Get a Fleet |
list_by_resource_group | SELECT | resourceGroupName, subscriptionId | List Fleet resources by resource group |
list_by_subscription | SELECT | subscriptionId | List Fleet resources by subscription ID |
create_or_update | INSERT | fleetName, resourceGroupName, subscriptionId | Create a Fleet |
delete | DELETE | fleetName, resourceGroupName, subscriptionId | Delete a Fleet |
update | UPDATE | fleetName, resourceGroupName, subscriptionId | Update a Fleet |
SELECT examples
List Fleet resources by subscription ID
- vw_fleets
- fleets
SELECT
compute_profile,
fleetName,
identity,
location,
plan,
provisioning_state,
regular_priority_profile,
resourceGroupName,
spot_priority_profile,
subscriptionId,
tags,
time_created,
unique_id,
vm_sizes_profile,
zones
FROM azure.azure_fleet.vw_fleets
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
identity,
location,
plan,
properties,
tags,
zones
FROM azure.azure_fleet.fleets
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT example
Use the following StackQL query and manifest file to create a new fleets resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.azure_fleet.fleets (
fleetName,
resourceGroupName,
subscriptionId,
properties,
zones,
identity,
plan,
tags,
location
)
SELECT
'{{ fleetName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ zones }}',
'{{ identity }}',
'{{ plan }}',
'{{ tags }}',
'{{ location }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: provisioningState
value: []
- name: spotPriorityProfile
value:
- name: capacity
value: integer
- name: minCapacity
value: integer
- name: maxPricePerVM
value: number
- name: evictionPolicy
value: []
- name: allocationStrategy
value: []
- name: maintain
value: boolean
- name: regularPriorityProfile
value:
- name: capacity
value: integer
- name: minCapacity
value: integer
- name: allocationStrategy
value: []
- name: vmSizesProfile
value:
- - name: name
value: string
- name: rank
value: integer
- name: computeProfile
value:
- name: baseVirtualMachineProfile
value:
- name: osProfile
value:
- name: computerNamePrefix
value: string
- name: adminUsername
value: string
- name: adminPassword
value: string
- name: customData
value: string
- name: windowsConfiguration
value:
- name: provisionVMAgent
value: boolean
- name: enableAutomaticUpdates
value: boolean
- name: timeZone
value: string
- name: additionalUnattendContent
value:
- - name: passName
value: string
- name: componentName
value: string
- name: settingName
value: []
- name: content
value: string
- name: patchSettings
value:
- name: patchMode
value: []
- name: enableHotpatching
value: boolean
- name: assessmentMode
value: []
- name: automaticByPlatformSettings
value:
- name: rebootSetting
value: []
- name: bypassPlatformSafetyChecksOnUserSchedule
value: boolean
- name: winRM
value:
- name: listeners
value:
- - name: protocol
value: []
- name: certificateUrl
value: string
- name: enableVMAgentPlatformUpdates
value: boolean
- name: linuxConfiguration
value:
- name: disablePasswordAuthentication
value: boolean
- name: ssh
value:
- name: publicKeys
value:
- - name: path
value: string
- name: keyData
value: string
- name: provisionVMAgent
value: boolean
- name: patchSettings
value:
- name: patchMode
value: []
- name: assessmentMode
value: []
- name: automaticByPlatformSettings
value:
- name: rebootSetting
value: []
- name: bypassPlatformSafetyChecksOnUserSchedule
value: boolean
- name: enableVMAgentPlatformUpdates
value: boolean
- name: secrets
value:
- - name: sourceVault
value:
- name: id
value: string
- name: vaultCertificates
value:
- - name: certificateUrl
value: string
- name: certificateStore
value: string
- name: allowExtensionOperations
value: boolean
- name: requireGuestProvisionSignal
value: boolean
- name: storageProfile
value:
- name: imageReference
value:
- name: id
value: string
- name: publisher
value: string
- name: offer
value: string
- name: sku
value: string
- name: version
value: string
- name: exactVersion
value: string
- name: sharedGalleryImageId
value: string
- name: communityGalleryImageId
value: string
- name: osDisk
value:
- name: name
value: string
- name: caching
value: []
- name: writeAcceleratorEnabled
value: boolean
- name: createOption
value: []
- name: diffDiskSettings
value:
- name: option
value: []
- name: placement
value: []
- name: diskSizeGB
value: integer
- name: osType
value: []
- name: image
value:
- name: uri
value: string
- name: vhdContainers
value:
- string
- name: managedDisk
value:
- name: storageAccountType
value: []
- name: diskEncryptionSet
value:
- name: id
value: string
- name: securityProfile
value:
- name: securityEncryptionType
value: []
- name: deleteOption
value: []
- name: dataDisks
value:
- - name: name
value: string
- name: lun
value: integer
- name: writeAcceleratorEnabled
value: boolean
- name: diskSizeGB
value: integer
- name: diskIOPSReadWrite
value: integer
- name: diskMBpsReadWrite
value: integer
- name: diskControllerType
value: []
- name: networkProfile
value:
- name: healthProbe
value:
- name: id
value: string
- name: networkInterfaceConfigurations
value:
- - name: name
value: string
- name: properties
value:
- name: primary
value: boolean
- name: enableAcceleratedNetworking
value: boolean
- name: disableTcpStateTracking
value: boolean
- name: enableFpga
value: boolean
- name: dnsSettings
value:
- name: dnsServers
value:
- string
- name: ipConfigurations
value:
- - name: name
value: string
- name: properties
value:
- name: primary
value: boolean
- name: publicIPAddressConfiguration
value:
- name: name
value: string
- name: properties
value:
- name: idleTimeoutInMinutes
value: integer
- name: dnsSettings
value: []
- name: ipTags
value:
- []
- name: publicIPAddressVersion
value: []
- name: deleteOption
value: []
- name: sku
value:
- name: name
value: []
- name: tier
value: []
- name: applicationGatewayBackendAddressPools
value:
- - name: id
value: string
- name: applicationSecurityGroups
value:
- - name: id
value: string
- name: loadBalancerBackendAddressPools
value:
- - name: id
value: string
- name: loadBalancerInboundNatPools
value:
- - name: id
value: string
- name: enableIPForwarding
value: boolean
- name: auxiliaryMode
value: []
- name: auxiliarySku
value: []
- name: networkApiVersion
value: []
- name: securityProfile
value:
- name: uefiSettings
value:
- name: secureBootEnabled
value: boolean
- name: vTpmEnabled
value: boolean
- name: encryptionAtHost
value: boolean
- name: securityType
value: []
- name: encryptionIdentity
value:
- name: userAssignedIdentityResourceId
value: string
- name: proxyAgentSettings
value:
- name: enabled
value: boolean
- name: mode
value: []
- name: keyIncarnationId
value: integer
- name: diagnosticsProfile
value:
- name: bootDiagnostics
value:
- name: enabled
value: boolean
- name: storageUri
value: string
- name: extensionProfile
value:
- name: extensions
value:
- - name: id
value: string
- name: name
value: string
- name: type
value: string
- name: properties
value:
- name: forceUpdateTag
value: string
- name: publisher
value: string
- name: type
value: string
- name: typeHandlerVersion
value: string
- name: autoUpgradeMinorVersion
value: boolean
- name: enableAutomaticUpgrade
value: boolean
- name: settings
value: object
- name: protectedSettings
value: object
- name: provisioningState
value: string
- name: provisionAfterExtensions
value:
- string
- name: suppressFailures
value: boolean
- name: protectedSettingsFromKeyVault
value:
- name: secretUrl
value: string
- name: extensionsTimeBudget
value: string
- name: licenseType
value: string
- name: scheduledEventsProfile
value:
- name: terminateNotificationProfile
value:
- name: notBeforeTimeout
value: string
- name: enable
value: boolean
- name: osImageNotificationProfile
value:
- name: notBeforeTimeout
value: string
- name: enable
value: boolean
- name: userData
value: string
- name: capacityReservation
value: []
- name: applicationProfile
value:
- name: galleryApplications
value:
- - name: tags
value: string
- name: order
value: integer
- name: packageReferenceId
value: string
- name: configurationReference
value: string
- name: treatFailureAsDeploymentFailure
value: boolean
- name: enableAutomaticUpgrade
value: boolean
- name: hardwareProfile
value:
- name: vmSizeProperties
value:
- name: vCPUsAvailable
value: integer
- name: vCPUsPerCore
value: integer
- name: serviceArtifactReference
value:
- name: id
value: string
- name: securityPostureReference
value:
- name: id
value: string
- name: excludeExtensions
value:
- string
- name: isOverridable
value: boolean
- name: timeCreated
value: string
- name: computeApiVersion
value: string
- name: platformFaultDomainCount
value: integer
- name: timeCreated
value: string
- name: uniqueId
value: string
- name: zones
value:
- string
- name: identity
value:
- name: principalId
value: string
- name: tenantId
value: string
- name: type
value: []
- name: userAssignedIdentities
value: []
- name: plan
value:
- name: name
value: string
- name: publisher
value: string
- name: product
value: string
- name: promotionCode
value: string
- name: version
value: string
- name: tags
value: object
- name: location
value: string
UPDATE example
Updates a fleets resource.
/*+ update */
UPDATE azure.azure_fleet.fleets
SET
tags = '{{ tags }}',
identity = '{{ identity }}',
plan = '{{ plan }}',
properties = '{{ properties }}'
WHERE
fleetName = '{{ fleetName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
DELETE example
Deletes the specified fleets resource.
/*+ delete */
DELETE FROM azure.azure_fleet.fleets
WHERE fleetName = '{{ fleetName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';