Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. desktopvirtualization
  5. getHostPool
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.desktopvirtualization.getHostPool

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a host pool. Azure REST API version: 2022-09-09.

Other available API versions: 2022-04-01-preview, 2022-10-14-preview, 2023-07-07-preview, 2023-09-05, 2023-10-04-preview, 2023-11-01-preview, 2024-01-16-preview, 2024-03-06-preview, 2024-04-03, 2024-04-08-preview, 2024-08-08-preview.

Using getHostPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHostPool(args: GetHostPoolArgs, opts?: InvokeOptions): Promise<GetHostPoolResult>
function getHostPoolOutput(args: GetHostPoolOutputArgs, opts?: InvokeOptions): Output<GetHostPoolResult>
Copy
def get_host_pool(host_pool_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetHostPoolResult
def get_host_pool_output(host_pool_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetHostPoolResult]
Copy
func LookupHostPool(ctx *Context, args *LookupHostPoolArgs, opts ...InvokeOption) (*LookupHostPoolResult, error)
func LookupHostPoolOutput(ctx *Context, args *LookupHostPoolOutputArgs, opts ...InvokeOption) LookupHostPoolResultOutput
Copy

> Note: This function is named LookupHostPool in the Go SDK.

public static class GetHostPool 
{
    public static Task<GetHostPoolResult> InvokeAsync(GetHostPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetHostPoolResult> Invoke(GetHostPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHostPoolResult> getHostPool(GetHostPoolArgs args, InvokeOptions options)
public static Output<GetHostPoolResult> getHostPool(GetHostPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:desktopvirtualization:getHostPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HostPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the host pool within the specified resource group
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
HostPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the host pool within the specified resource group
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
hostPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the host pool within the specified resource group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
hostPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the host pool within the specified resource group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
host_pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the host pool within the specified resource group
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
hostPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the host pool within the specified resource group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getHostPool Result

The following output properties are available:

ApplicationGroupReferences List<string>
List of applicationGroup links.
CloudPcResource bool
Is cloud pc resource.
Etag string
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.
HostPoolType string
HostPool type for desktop.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LoadBalancerType string
The type of the load balancer.
Name string
The name of the resource
ObjectId string
ObjectId of HostPool. (internal use)
PreferredAppGroupType string
The type of preferred application group type, default to Desktop Application Group
SystemData Pulumi.AzureNative.DesktopVirtualization.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AgentUpdate Pulumi.AzureNative.DesktopVirtualization.Outputs.AgentUpdatePropertiesResponse
The session host configuration for updating agent, monitoring agent, and stack component.
CustomRdpProperty string
Custom rdp property of HostPool.
Description string
Description of HostPool.
FriendlyName string
Friendly name of HostPool.
Identity Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseIdentity
Kind string
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.
Location string
The geo-location where the resource lives
ManagedBy string
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.
MaxSessionLimit int
The max session limit of HostPool.
PersonalDesktopAssignmentType string
PersonalDesktopAssignment type for HostPool.
Plan Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponsePlan
RegistrationInfo Pulumi.AzureNative.DesktopVirtualization.Outputs.RegistrationInfoResponse
The registration info of HostPool.
Ring int
The ring number of HostPool.
Sku Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseSku
SsoClientId string
ClientId for the registered Relying Party used to issue WVD SSO certificates.
SsoClientSecretKeyVaultPath string
Path to Azure KeyVault storing the secret used for communication to ADFS.
SsoSecretType string
The type of single sign on Secret Type.
SsoadfsAuthority string
URL to customer ADFS server for signing WVD SSO certificates.
StartVMOnConnect bool
The flag to turn on/off StartVMOnConnect feature.
Tags Dictionary<string, string>
Resource tags.
ValidationEnvironment bool
Is validation environment.
VmTemplate string
VM template for sessionhosts configuration within hostpool.
ApplicationGroupReferences []string
List of applicationGroup links.
CloudPcResource bool
Is cloud pc resource.
Etag string
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.
HostPoolType string
HostPool type for desktop.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LoadBalancerType string
The type of the load balancer.
Name string
The name of the resource
ObjectId string
ObjectId of HostPool. (internal use)
PreferredAppGroupType string
The type of preferred application group type, default to Desktop Application Group
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AgentUpdate AgentUpdatePropertiesResponse
The session host configuration for updating agent, monitoring agent, and stack component.
CustomRdpProperty string
Custom rdp property of HostPool.
Description string
Description of HostPool.
FriendlyName string
Friendly name of HostPool.
Identity ResourceModelWithAllowedPropertySetResponseIdentity
Kind string
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.
Location string
The geo-location where the resource lives
ManagedBy string
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.
MaxSessionLimit int
The max session limit of HostPool.
PersonalDesktopAssignmentType string
PersonalDesktopAssignment type for HostPool.
Plan ResourceModelWithAllowedPropertySetResponsePlan
RegistrationInfo RegistrationInfoResponse
The registration info of HostPool.
Ring int
The ring number of HostPool.
Sku ResourceModelWithAllowedPropertySetResponseSku
SsoClientId string
ClientId for the registered Relying Party used to issue WVD SSO certificates.
SsoClientSecretKeyVaultPath string
Path to Azure KeyVault storing the secret used for communication to ADFS.
SsoSecretType string
The type of single sign on Secret Type.
SsoadfsAuthority string
URL to customer ADFS server for signing WVD SSO certificates.
StartVMOnConnect bool
The flag to turn on/off StartVMOnConnect feature.
Tags map[string]string
Resource tags.
ValidationEnvironment bool
Is validation environment.
VmTemplate string
VM template for sessionhosts configuration within hostpool.
applicationGroupReferences List<String>
List of applicationGroup links.
cloudPcResource Boolean
Is cloud pc resource.
etag String
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.
hostPoolType String
HostPool type for desktop.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
loadBalancerType String
The type of the load balancer.
name String
The name of the resource
objectId String
ObjectId of HostPool. (internal use)
preferredAppGroupType String
The type of preferred application group type, default to Desktop Application Group
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agentUpdate AgentUpdatePropertiesResponse
The session host configuration for updating agent, monitoring agent, and stack component.
customRdpProperty String
Custom rdp property of HostPool.
description String
Description of HostPool.
friendlyName String
Friendly name of HostPool.
identity ResourceModelWithAllowedPropertySetResponseIdentity
kind String
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.
location String
The geo-location where the resource lives
managedBy String
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.
maxSessionLimit Integer
The max session limit of HostPool.
personalDesktopAssignmentType String
PersonalDesktopAssignment type for HostPool.
plan ResourceModelWithAllowedPropertySetResponsePlan
registrationInfo RegistrationInfoResponse
The registration info of HostPool.
ring Integer
The ring number of HostPool.
sku ResourceModelWithAllowedPropertySetResponseSku
ssoClientId String
ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath String
Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType String
The type of single sign on Secret Type.
ssoadfsAuthority String
URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect Boolean
The flag to turn on/off StartVMOnConnect feature.
tags Map<String,String>
Resource tags.
validationEnvironment Boolean
Is validation environment.
vmTemplate String
VM template for sessionhosts configuration within hostpool.
applicationGroupReferences string[]
List of applicationGroup links.
cloudPcResource boolean
Is cloud pc resource.
etag string
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.
hostPoolType string
HostPool type for desktop.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
loadBalancerType string
The type of the load balancer.
name string
The name of the resource
objectId string
ObjectId of HostPool. (internal use)
preferredAppGroupType string
The type of preferred application group type, default to Desktop Application Group
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agentUpdate AgentUpdatePropertiesResponse
The session host configuration for updating agent, monitoring agent, and stack component.
customRdpProperty string
Custom rdp property of HostPool.
description string
Description of HostPool.
friendlyName string
Friendly name of HostPool.
identity ResourceModelWithAllowedPropertySetResponseIdentity
kind string
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.
location string
The geo-location where the resource lives
managedBy string
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.
maxSessionLimit number
The max session limit of HostPool.
personalDesktopAssignmentType string
PersonalDesktopAssignment type for HostPool.
plan ResourceModelWithAllowedPropertySetResponsePlan
registrationInfo RegistrationInfoResponse
The registration info of HostPool.
ring number
The ring number of HostPool.
sku ResourceModelWithAllowedPropertySetResponseSku
ssoClientId string
ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath string
Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType string
The type of single sign on Secret Type.
ssoadfsAuthority string
URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect boolean
The flag to turn on/off StartVMOnConnect feature.
tags {[key: string]: string}
Resource tags.
validationEnvironment boolean
Is validation environment.
vmTemplate string
VM template for sessionhosts configuration within hostpool.
application_group_references Sequence[str]
List of applicationGroup links.
cloud_pc_resource bool
Is cloud pc resource.
etag str
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.
host_pool_type str
HostPool type for desktop.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
load_balancer_type str
The type of the load balancer.
name str
The name of the resource
object_id str
ObjectId of HostPool. (internal use)
preferred_app_group_type str
The type of preferred application group type, default to Desktop Application Group
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agent_update AgentUpdatePropertiesResponse
The session host configuration for updating agent, monitoring agent, and stack component.
custom_rdp_property str
Custom rdp property of HostPool.
description str
Description of HostPool.
friendly_name str
Friendly name of HostPool.
identity ResourceModelWithAllowedPropertySetResponseIdentity
kind str
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.
location str
The geo-location where the resource lives
managed_by str
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.
max_session_limit int
The max session limit of HostPool.
personal_desktop_assignment_type str
PersonalDesktopAssignment type for HostPool.
plan ResourceModelWithAllowedPropertySetResponsePlan
registration_info RegistrationInfoResponse
The registration info of HostPool.
ring int
The ring number of HostPool.
sku ResourceModelWithAllowedPropertySetResponseSku
sso_client_id str
ClientId for the registered Relying Party used to issue WVD SSO certificates.
sso_client_secret_key_vault_path str
Path to Azure KeyVault storing the secret used for communication to ADFS.
sso_secret_type str
The type of single sign on Secret Type.
ssoadfs_authority str
URL to customer ADFS server for signing WVD SSO certificates.
start_vm_on_connect bool
The flag to turn on/off StartVMOnConnect feature.
tags Mapping[str, str]
Resource tags.
validation_environment bool
Is validation environment.
vm_template str
VM template for sessionhosts configuration within hostpool.
applicationGroupReferences List<String>
List of applicationGroup links.
cloudPcResource Boolean
Is cloud pc resource.
etag String
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.
hostPoolType String
HostPool type for desktop.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
loadBalancerType String
The type of the load balancer.
name String
The name of the resource
objectId String
ObjectId of HostPool. (internal use)
preferredAppGroupType String
The type of preferred application group type, default to Desktop Application Group
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
agentUpdate Property Map
The session host configuration for updating agent, monitoring agent, and stack component.
customRdpProperty String
Custom rdp property of HostPool.
description String
Description of HostPool.
friendlyName String
Friendly name of HostPool.
identity Property Map
kind String
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.
location String
The geo-location where the resource lives
managedBy String
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.
maxSessionLimit Number
The max session limit of HostPool.
personalDesktopAssignmentType String
PersonalDesktopAssignment type for HostPool.
plan Property Map
registrationInfo Property Map
The registration info of HostPool.
ring Number
The ring number of HostPool.
sku Property Map
ssoClientId String
ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath String
Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType String
The type of single sign on Secret Type.
ssoadfsAuthority String
URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect Boolean
The flag to turn on/off StartVMOnConnect feature.
tags Map<String>
Resource tags.
validationEnvironment Boolean
Is validation environment.
vmTemplate String
VM template for sessionhosts configuration within hostpool.

Supporting Types

AgentUpdatePropertiesResponse

MaintenanceWindowTimeZone string
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.
MaintenanceWindows List<Pulumi.AzureNative.DesktopVirtualization.Inputs.MaintenanceWindowPropertiesResponse>
List of maintenance windows. Maintenance windows are 2 hours long.
Type string
The type of maintenance for session host components.
UseSessionHostLocalTime bool
Whether to use localTime of the virtual machine.
MaintenanceWindowTimeZone string
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.
MaintenanceWindows []MaintenanceWindowPropertiesResponse
List of maintenance windows. Maintenance windows are 2 hours long.
Type string
The type of maintenance for session host components.
UseSessionHostLocalTime bool
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone String
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.
maintenanceWindows List<MaintenanceWindowPropertiesResponse>
List of maintenance windows. Maintenance windows are 2 hours long.
type String
The type of maintenance for session host components.
useSessionHostLocalTime Boolean
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone string
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.
maintenanceWindows MaintenanceWindowPropertiesResponse[]
List of maintenance windows. Maintenance windows are 2 hours long.
type string
The type of maintenance for session host components.
useSessionHostLocalTime boolean
Whether to use localTime of the virtual machine.
maintenance_window_time_zone str
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.
maintenance_windows Sequence[MaintenanceWindowPropertiesResponse]
List of maintenance windows. Maintenance windows are 2 hours long.
type str
The type of maintenance for session host components.
use_session_host_local_time bool
Whether to use localTime of the virtual machine.
maintenanceWindowTimeZone String
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.
maintenanceWindows List<Property Map>
List of maintenance windows. Maintenance windows are 2 hours long.
type String
The type of maintenance for session host components.
useSessionHostLocalTime Boolean
Whether to use localTime of the virtual machine.

MaintenanceWindowPropertiesResponse

DayOfWeek string
Day of the week.
Hour int
The update start hour of the day. (0 - 23)
DayOfWeek string
Day of the week.
Hour int
The update start hour of the day. (0 - 23)
dayOfWeek String
Day of the week.
hour Integer
The update start hour of the day. (0 - 23)
dayOfWeek string
Day of the week.
hour number
The update start hour of the day. (0 - 23)
day_of_week str
Day of the week.
hour int
The update start hour of the day. (0 - 23)
dayOfWeek String
Day of the week.
hour Number
The update start hour of the day. (0 - 23)

RegistrationInfoResponse

ExpirationTime string
Expiration time of registration token.
RegistrationTokenOperation string
The type of resetting the token.
Token string
The registration token base64 encoded string.
ExpirationTime string
Expiration time of registration token.
RegistrationTokenOperation string
The type of resetting the token.
Token string
The registration token base64 encoded string.
expirationTime String
Expiration time of registration token.
registrationTokenOperation String
The type of resetting the token.
token String
The registration token base64 encoded string.
expirationTime string
Expiration time of registration token.
registrationTokenOperation string
The type of resetting the token.
token string
The registration token base64 encoded string.
expiration_time str
Expiration time of registration token.
registration_token_operation str
The type of resetting the token.
token str
The registration token base64 encoded string.
expirationTime String
Expiration time of registration token.
registrationTokenOperation String
The type of resetting the token.
token String
The registration token base64 encoded string.

ResourceModelWithAllowedPropertySetResponseIdentity

PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.
principalId This property is required. string
The principal ID of resource identity.
tenantId This property is required. string
The tenant ID of resource.
type string
The identity type.
principal_id This property is required. str
The principal ID of resource identity.
tenant_id This property is required. str
The tenant ID of resource.
type str
The identity type.
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.

ResourceModelWithAllowedPropertySetResponsePlan

Name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
Product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
Publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string
The version of the desired product/artifact.
Name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
Product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
Publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string
The version of the desired product/artifact.
name This property is required. String
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. String
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. String
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String
The version of the desired product/artifact.
name This property is required. string
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. string
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. string
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode string
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version string
The version of the desired product/artifact.
name This property is required. str
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. str
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. str
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotion_code str
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version str
The version of the desired product/artifact.
name This property is required. String
A user defined name of the 3rd Party Artifact that is being procured.
product This property is required. String
The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
publisher This property is required. String
The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String
A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String
The version of the desired product/artifact.

ResourceModelWithAllowedPropertySetResponseSku

Name This property is required. string
The name of the SKU. Ex - P3. It is typically a letter+number code
Capacity int
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.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string
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.
Name This property is required. string
The name of the SKU. Ex - P3. It is typically a letter+number code
Capacity int
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.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string
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.
name This property is required. String
The name of the SKU. Ex - P3. It is typically a letter+number code
capacity Integer
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.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String
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.
name This property is required. string
The name of the SKU. Ex - P3. It is typically a letter+number code
capacity number
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.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier string
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.
name This property is required. str
The name of the SKU. Ex - P3. It is typically a letter+number code
capacity int
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.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier str
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.
name This property is required. String
The name of the SKU. Ex - P3. It is typically a letter+number code
capacity Number
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.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String
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.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native