Azure Native v2.89.3, Mar 20 25

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.compute.getCloudService

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getCloudService

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 getCloudService(args: GetCloudServiceArgs, opts?: InvokeOptions): Promise<GetCloudServiceResult>
function getCloudServiceOutput(args: GetCloudServiceOutputArgs, opts?: InvokeOptions): Output<GetCloudServiceResult>

def get_cloud_service(cloud_service_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCloudServiceResult
def get_cloud_service_output(cloud_service_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCloudServiceResult]

func LookupCloudService(ctx *Context, args *LookupCloudServiceArgs, opts ...InvokeOption) (*LookupCloudServiceResult, error)
func LookupCloudServiceOutput(ctx *Context, args *LookupCloudServiceOutputArgs, opts ...InvokeOption) LookupCloudServiceResultOutput

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

public static class GetCloudService 
{
    public static Task<GetCloudServiceResult> InvokeAsync(GetCloudServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudServiceResult> Invoke(GetCloudServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudServiceResult> getCloudService(GetCloudServiceArgs args, InvokeOptions options)
public static Output<GetCloudServiceResult> getCloudService(GetCloudServiceArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:compute:getCloudService
  arguments:
    # arguments dictionary

The following arguments are supported:

CloudServiceName string: Name of the cloud service.
ResourceGroupName string: Name of the resource group.

CloudServiceName string: Name of the cloud service.
ResourceGroupName string: Name of the resource group.

cloudServiceName String: Name of the cloud service.
resourceGroupName String: Name of the resource group.

cloudServiceName string: Name of the cloud service.
resourceGroupName string: Name of the resource group.

cloud_service_name str: Name of the cloud service.
resource_group_name str: Name of the resource group.

cloudServiceName String: Name of the cloud service.
resourceGroupName String: Name of the resource group.

getCloudService Result

The following output properties are available:

Id string: Resource Id.
Location string: Resource location.
Name string: Resource name.
Properties Pulumi.AzureNative.Compute.Outputs.CloudServicePropertiesResponse: Cloud service properties
Type string: Resource type.
SystemData Pulumi.AzureNative.Compute.Outputs.SystemDataResponse: The system meta data relating to this resource.
Tags Dictionary<string, string>: Resource tags.
Zones List<string>: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.

Id string: Resource Id.
Location string: Resource location.
Name string: Resource name.
Properties CloudServicePropertiesResponse: Cloud service properties
Type string: Resource type.
SystemData SystemDataResponse: The system meta data relating to this resource.
Tags map[string]string: Resource tags.
Zones []string: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.

id String: Resource Id.
location String: Resource location.
name String: Resource name.
properties CloudServicePropertiesResponse: Cloud service properties
type String: Resource type.
systemData SystemDataResponse: The system meta data relating to this resource.
tags Map<String,String>: Resource tags.
zones List<String>: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.

id string: Resource Id.
location string: Resource location.
name string: Resource name.
properties CloudServicePropertiesResponse: Cloud service properties
type string: Resource type.
systemData SystemDataResponse: The system meta data relating to this resource.
tags {[key: string]: string}: Resource tags.
zones string[]: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.

id str: Resource Id.
location str: Resource location.
name str: Resource name.
properties CloudServicePropertiesResponse: Cloud service properties
type str: Resource type.
system_data SystemDataResponse: The system meta data relating to this resource.
tags Mapping[str, str]: Resource tags.
zones Sequence[str]: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.

id String: Resource Id.
location String: Resource location.
name String: Resource name.
properties Property Map: Cloud service properties
type String: Resource type.
systemData Property Map: The system meta data relating to this resource.
tags Map<String>: Resource tags.
zones List<String>: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.

Supporting Types

CloudServiceExtensionProfileResponse

Extensions List<Pulumi.AzureNative.Compute.Inputs.ExtensionResponse>: List of extensions for the cloud service.

Extensions []ExtensionResponse: List of extensions for the cloud service.

extensions List<ExtensionResponse>: List of extensions for the cloud service.

extensions ExtensionResponse[]: List of extensions for the cloud service.

extensions Sequence[ExtensionResponse]: List of extensions for the cloud service.

extensions List<Property Map>: List of extensions for the cloud service.

CloudServiceExtensionPropertiesResponse

ProvisioningState string: The provisioning state, which only appears in the response.
AutoUpgradeMinorVersion bool: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
ForceUpdateTag string: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not
ProtectedSettings object: Protected settings for the extension which are encrypted before sent to the role instance.
ProtectedSettingsFromKeyVault Pulumi.AzureNative.Compute.Inputs.CloudServiceVaultAndSecretReferenceResponse: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
Publisher string: The name of the extension handler publisher.
RolesAppliedTo List<string>: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
Settings object: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
Type string: Specifies the type of the extension.
TypeHandlerVersion string: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

ProvisioningState string: The provisioning state, which only appears in the response.
AutoUpgradeMinorVersion bool: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
ForceUpdateTag string: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not
ProtectedSettings interface{}: Protected settings for the extension which are encrypted before sent to the role instance.
ProtectedSettingsFromKeyVault CloudServiceVaultAndSecretReferenceResponse: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
Publisher string: The name of the extension handler publisher.
RolesAppliedTo []string: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
Settings interface{}: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
Type string: Specifies the type of the extension.
TypeHandlerVersion string: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

provisioningState String: The provisioning state, which only appears in the response.
autoUpgradeMinorVersion Boolean: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
forceUpdateTag String: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not
protectedSettings Object: Protected settings for the extension which are encrypted before sent to the role instance.
protectedSettingsFromKeyVault CloudServiceVaultAndSecretReferenceResponse: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
publisher String: The name of the extension handler publisher.
rolesAppliedTo List<String>: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
settings Object: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
type String: Specifies the type of the extension.
typeHandlerVersion String: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

provisioningState string: The provisioning state, which only appears in the response.
autoUpgradeMinorVersion boolean: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
forceUpdateTag string: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not
protectedSettings any: Protected settings for the extension which are encrypted before sent to the role instance.
protectedSettingsFromKeyVault CloudServiceVaultAndSecretReferenceResponse: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
publisher string: The name of the extension handler publisher.
rolesAppliedTo string[]: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
settings any: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
type string: Specifies the type of the extension.
typeHandlerVersion string: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

provisioning_state str: The provisioning state, which only appears in the response.
auto_upgrade_minor_version bool: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
force_update_tag str: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not
protected_settings Any: Protected settings for the extension which are encrypted before sent to the role instance.
protected_settings_from_key_vault CloudServiceVaultAndSecretReferenceResponse: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
publisher str: The name of the extension handler publisher.
roles_applied_to Sequence[str]: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
settings Any: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
type str: Specifies the type of the extension.
type_handler_version str: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

provisioningState String: The provisioning state, which only appears in the response.
autoUpgradeMinorVersion Boolean: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
forceUpdateTag String: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not
protectedSettings Any: Protected settings for the extension which are encrypted before sent to the role instance.
protectedSettingsFromKeyVault Property Map: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
publisher String: The name of the extension handler publisher.
rolesAppliedTo List<String>: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
settings Any: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
type String: Specifies the type of the extension.
typeHandlerVersion String: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

CloudServiceNetworkProfileResponse

LoadBalancerConfigurations List<Pulumi.AzureNative.Compute.Inputs.LoadBalancerConfigurationResponse>: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
SlotType string: Slot type for the cloud service. Possible values are ProductionStaging If not specified, the default value is Production.
SwappableCloudService Pulumi.AzureNative.Compute.Inputs.SubResourceResponse: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.

LoadBalancerConfigurations []LoadBalancerConfigurationResponse: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
SlotType string: Slot type for the cloud service. Possible values are ProductionStaging If not specified, the default value is Production.
SwappableCloudService SubResourceResponse: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.

loadBalancerConfigurations List<LoadBalancerConfigurationResponse>: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
slotType String: Slot type for the cloud service. Possible values are ProductionStaging If not specified, the default value is Production.
swappableCloudService SubResourceResponse: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.

loadBalancerConfigurations LoadBalancerConfigurationResponse[]: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
slotType string: Slot type for the cloud service. Possible values are ProductionStaging If not specified, the default value is Production.
swappableCloudService SubResourceResponse: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.

load_balancer_configurations Sequence[LoadBalancerConfigurationResponse]: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
slot_type str: Slot type for the cloud service. Possible values are ProductionStaging If not specified, the default value is Production.
swappable_cloud_service SubResourceResponse: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.

loadBalancerConfigurations List<Property Map>: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
slotType String: Slot type for the cloud service. Possible values are ProductionStaging If not specified, the default value is Production.
swappableCloudService Property Map: The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.

CloudServiceOsProfileResponse

Secrets List<Pulumi.AzureNative.Compute.Inputs.CloudServiceVaultSecretGroupResponse>: Specifies set of certificates that should be installed onto the role instances.

Secrets []CloudServiceVaultSecretGroupResponse: Specifies set of certificates that should be installed onto the role instances.

secrets List<CloudServiceVaultSecretGroupResponse>: Specifies set of certificates that should be installed onto the role instances.

secrets CloudServiceVaultSecretGroupResponse[]: Specifies set of certificates that should be installed onto the role instances.

secrets Sequence[CloudServiceVaultSecretGroupResponse]: Specifies set of certificates that should be installed onto the role instances.

secrets List<Property Map>: Specifies set of certificates that should be installed onto the role instances.

CloudServicePropertiesResponse

ProvisioningState string: The provisioning state, which only appears in the response.
UniqueId string: The unique identifier for the cloud service.
AllowModelOverride bool: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is false.
Configuration string: Specifies the XML service configuration (.cscfg) for the cloud service.
ConfigurationUrl string: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
ExtensionProfile Pulumi.AzureNative.Compute.Inputs.CloudServiceExtensionProfileResponse: Describes a cloud service extension profile.
NetworkProfile Pulumi.AzureNative.Compute.Inputs.CloudServiceNetworkProfileResponse: Network Profile for the cloud service.
OsProfile Pulumi.AzureNative.Compute.Inputs.CloudServiceOsProfileResponse: Describes the OS profile for the cloud service.
PackageUrl string: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
RoleProfile Pulumi.AzureNative.Compute.Inputs.CloudServiceRoleProfileResponse: Describes the role profile for the cloud service.
StartCloudService bool: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
UpgradeMode string: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are AutoManual Simultaneous If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.

ProvisioningState string: The provisioning state, which only appears in the response.
UniqueId string: The unique identifier for the cloud service.
AllowModelOverride bool: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is false.
Configuration string: Specifies the XML service configuration (.cscfg) for the cloud service.
ConfigurationUrl string: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
ExtensionProfile CloudServiceExtensionProfileResponse: Describes a cloud service extension profile.
NetworkProfile CloudServiceNetworkProfileResponse: Network Profile for the cloud service.
OsProfile CloudServiceOsProfileResponse: Describes the OS profile for the cloud service.
PackageUrl string: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
RoleProfile CloudServiceRoleProfileResponse: Describes the role profile for the cloud service.
StartCloudService bool: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
UpgradeMode string: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are AutoManual Simultaneous If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.

provisioningState String: The provisioning state, which only appears in the response.
uniqueId String: The unique identifier for the cloud service.
allowModelOverride Boolean: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is false.
configuration String: Specifies the XML service configuration (.cscfg) for the cloud service.
configurationUrl String: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
extensionProfile CloudServiceExtensionProfileResponse: Describes a cloud service extension profile.
networkProfile CloudServiceNetworkProfileResponse: Network Profile for the cloud service.
osProfile CloudServiceOsProfileResponse: Describes the OS profile for the cloud service.
packageUrl String: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
roleProfile CloudServiceRoleProfileResponse: Describes the role profile for the cloud service.
startCloudService Boolean: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
upgradeMode String: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are AutoManual Simultaneous If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.

provisioningState string: The provisioning state, which only appears in the response.
uniqueId string: The unique identifier for the cloud service.
allowModelOverride boolean: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is false.
configuration string: Specifies the XML service configuration (.cscfg) for the cloud service.
configurationUrl string: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
extensionProfile CloudServiceExtensionProfileResponse: Describes a cloud service extension profile.
networkProfile CloudServiceNetworkProfileResponse: Network Profile for the cloud service.
osProfile CloudServiceOsProfileResponse: Describes the OS profile for the cloud service.
packageUrl string: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
roleProfile CloudServiceRoleProfileResponse: Describes the role profile for the cloud service.
startCloudService boolean: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
upgradeMode string: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are AutoManual Simultaneous If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.

provisioning_state str: The provisioning state, which only appears in the response.
unique_id str: The unique identifier for the cloud service.
allow_model_override bool: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is false.
configuration str: Specifies the XML service configuration (.cscfg) for the cloud service.
configuration_url str: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
extension_profile CloudServiceExtensionProfileResponse: Describes a cloud service extension profile.
network_profile CloudServiceNetworkProfileResponse: Network Profile for the cloud service.
os_profile CloudServiceOsProfileResponse: Describes the OS profile for the cloud service.
package_url str: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
role_profile CloudServiceRoleProfileResponse: Describes the role profile for the cloud service.
start_cloud_service bool: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
upgrade_mode str: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are AutoManual Simultaneous If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.

provisioningState String: The provisioning state, which only appears in the response.
uniqueId String: The unique identifier for the cloud service.
allowModelOverride Boolean: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. The default value is false.
configuration String: Specifies the XML service configuration (.cscfg) for the cloud service.
configurationUrl String: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
extensionProfile Property Map: Describes a cloud service extension profile.
networkProfile Property Map: Network Profile for the cloud service.
osProfile Property Map: Describes the OS profile for the cloud service.
packageUrl String: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. This is a write-only property and is not returned in GET calls.
roleProfile Property Map: Describes the role profile for the cloud service.
startCloudService Boolean: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
upgradeMode String: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. Possible Values are AutoManual Simultaneous If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.

CloudServiceRoleProfilePropertiesResponse

Name string: Resource name.
Sku Pulumi.AzureNative.Compute.Inputs.CloudServiceRoleSkuResponse: Describes the cloud service role sku.

Name string: Resource name.
Sku CloudServiceRoleSkuResponse: Describes the cloud service role sku.

name String: Resource name.
sku CloudServiceRoleSkuResponse: Describes the cloud service role sku.

name string: Resource name.
sku CloudServiceRoleSkuResponse: Describes the cloud service role sku.

name str: Resource name.
sku CloudServiceRoleSkuResponse: Describes the cloud service role sku.

name String: Resource name.
sku Property Map: Describes the cloud service role sku.

CloudServiceRoleProfileResponse

Roles List<Pulumi.AzureNative.Compute.Inputs.CloudServiceRoleProfilePropertiesResponse>: List of roles for the cloud service.

Roles []CloudServiceRoleProfilePropertiesResponse: List of roles for the cloud service.

roles List<CloudServiceRoleProfilePropertiesResponse>: List of roles for the cloud service.

roles CloudServiceRoleProfilePropertiesResponse[]: List of roles for the cloud service.

roles Sequence[CloudServiceRoleProfilePropertiesResponse]: List of roles for the cloud service.

roles List<Property Map>: List of roles for the cloud service.

CloudServiceRoleSkuResponse

Capacity double: Specifies the number of role instances in the cloud service.
Name string: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
Tier string: Specifies the tier of the cloud service. Possible Values are Standard Basic

Capacity float64: Specifies the number of role instances in the cloud service.
Name string: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
Tier string: Specifies the tier of the cloud service. Possible Values are Standard Basic

capacity Double: Specifies the number of role instances in the cloud service.
name String: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
tier String: Specifies the tier of the cloud service. Possible Values are Standard Basic

capacity number: Specifies the number of role instances in the cloud service.
name string: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
tier string: Specifies the tier of the cloud service. Possible Values are Standard Basic

capacity float: Specifies the number of role instances in the cloud service.
name str: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
tier str: Specifies the tier of the cloud service. Possible Values are Standard Basic

capacity Number: Specifies the number of role instances in the cloud service.
name String: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
tier String: Specifies the tier of the cloud service. Possible Values are Standard Basic

CloudServiceVaultAndSecretReferenceResponse

SecretUrl string: Secret URL which contains the protected settings of the extension
SourceVault Pulumi.AzureNative.Compute.Inputs.SubResourceResponse: The ARM Resource ID of the Key Vault

SecretUrl string: Secret URL which contains the protected settings of the extension
SourceVault SubResourceResponse: The ARM Resource ID of the Key Vault

secretUrl String: Secret URL which contains the protected settings of the extension
sourceVault SubResourceResponse: The ARM Resource ID of the Key Vault

secretUrl string: Secret URL which contains the protected settings of the extension
sourceVault SubResourceResponse: The ARM Resource ID of the Key Vault

secret_url str: Secret URL which contains the protected settings of the extension
source_vault SubResourceResponse: The ARM Resource ID of the Key Vault

secretUrl String: Secret URL which contains the protected settings of the extension
sourceVault Property Map: The ARM Resource ID of the Key Vault

CloudServiceVaultCertificateResponse

CertificateUrl string: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

CertificateUrl string: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

certificateUrl String: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

certificateUrl string: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

certificate_url str: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

certificateUrl String: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

CloudServiceVaultSecretGroupResponse

SourceVault Pulumi.AzureNative.Compute.Inputs.SubResourceResponse: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
VaultCertificates List<Pulumi.AzureNative.Compute.Inputs.CloudServiceVaultCertificateResponse>: The list of key vault references in SourceVault which contain certificates.

SourceVault SubResourceResponse: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
VaultCertificates []CloudServiceVaultCertificateResponse: The list of key vault references in SourceVault which contain certificates.

sourceVault SubResourceResponse: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates List<CloudServiceVaultCertificateResponse>: The list of key vault references in SourceVault which contain certificates.

sourceVault SubResourceResponse: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates CloudServiceVaultCertificateResponse[]: The list of key vault references in SourceVault which contain certificates.

source_vault SubResourceResponse: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificates Sequence[CloudServiceVaultCertificateResponse]: The list of key vault references in SourceVault which contain certificates.

sourceVault Property Map: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates List<Property Map>: The list of key vault references in SourceVault which contain certificates.

ExtensionResponse

Name string: The name of the extension.
Properties Pulumi.AzureNative.Compute.Inputs.CloudServiceExtensionPropertiesResponse: Extension Properties.

Name string: The name of the extension.
Properties CloudServiceExtensionPropertiesResponse: Extension Properties.

name String: The name of the extension.
properties CloudServiceExtensionPropertiesResponse: Extension Properties.

name string: The name of the extension.
properties CloudServiceExtensionPropertiesResponse: Extension Properties.

name str: The name of the extension.
properties CloudServiceExtensionPropertiesResponse: Extension Properties.

name String: The name of the extension.
properties Property Map: Extension Properties.

LoadBalancerConfigurationPropertiesResponse

FrontendIpConfigurations List<Pulumi.AzureNative.Compute.Inputs.LoadBalancerFrontendIpConfigurationResponse>: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

FrontendIpConfigurations []LoadBalancerFrontendIpConfigurationResponse: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

frontendIpConfigurations List<LoadBalancerFrontendIpConfigurationResponse>: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

frontendIpConfigurations LoadBalancerFrontendIpConfigurationResponse[]: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

frontend_ip_configurations Sequence[LoadBalancerFrontendIpConfigurationResponse]: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

frontendIpConfigurations List<Property Map>: Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

LoadBalancerConfigurationResponse

Name string: The name of the Load balancer
Properties Pulumi.AzureNative.Compute.Inputs.LoadBalancerConfigurationPropertiesResponse: Properties of the load balancer configuration.
Id string: Resource Id

Name string: The name of the Load balancer
Properties LoadBalancerConfigurationPropertiesResponse: Properties of the load balancer configuration.
Id string: Resource Id

name String: The name of the Load balancer
properties LoadBalancerConfigurationPropertiesResponse: Properties of the load balancer configuration.
id String: Resource Id

name string: The name of the Load balancer
properties LoadBalancerConfigurationPropertiesResponse: Properties of the load balancer configuration.
id string: Resource Id

name str: The name of the Load balancer
properties LoadBalancerConfigurationPropertiesResponse: Properties of the load balancer configuration.
id str: Resource Id

name String: The name of the Load balancer
properties Property Map: Properties of the load balancer configuration.
id String: Resource Id

LoadBalancerFrontendIpConfigurationPropertiesResponse

PrivateIPAddress string: The virtual network private IP address of the IP configuration.
PublicIPAddress Pulumi.AzureNative.Compute.Inputs.SubResourceResponse: The reference to the public ip address resource.
Subnet Pulumi.AzureNative.Compute.Inputs.SubResourceResponse: The reference to the virtual network subnet resource.

PrivateIPAddress string: The virtual network private IP address of the IP configuration.
PublicIPAddress SubResourceResponse: The reference to the public ip address resource.
Subnet SubResourceResponse: The reference to the virtual network subnet resource.

privateIPAddress String: The virtual network private IP address of the IP configuration.
publicIPAddress SubResourceResponse: The reference to the public ip address resource.
subnet SubResourceResponse: The reference to the virtual network subnet resource.

privateIPAddress string: The virtual network private IP address of the IP configuration.
publicIPAddress SubResourceResponse: The reference to the public ip address resource.
subnet SubResourceResponse: The reference to the virtual network subnet resource.

private_ip_address str: The virtual network private IP address of the IP configuration.
public_ip_address SubResourceResponse: The reference to the public ip address resource.
subnet SubResourceResponse: The reference to the virtual network subnet resource.

privateIPAddress String: The virtual network private IP address of the IP configuration.
publicIPAddress Property Map: The reference to the public ip address resource.
subnet Property Map: The reference to the virtual network subnet resource.

LoadBalancerFrontendIpConfigurationResponse

Name string: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
Properties Pulumi.AzureNative.Compute.Inputs.LoadBalancerFrontendIpConfigurationPropertiesResponse: Properties of load balancer frontend ip configuration.

Name string: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
Properties LoadBalancerFrontendIpConfigurationPropertiesResponse: Properties of load balancer frontend ip configuration.

name String: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
properties LoadBalancerFrontendIpConfigurationPropertiesResponse: Properties of load balancer frontend ip configuration.

name string: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
properties LoadBalancerFrontendIpConfigurationPropertiesResponse: Properties of load balancer frontend ip configuration.

name str: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
properties LoadBalancerFrontendIpConfigurationPropertiesResponse: Properties of load balancer frontend ip configuration.

name String: The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
properties Property Map: Properties of load balancer frontend ip configuration.

SubResourceResponse

Id string: Resource Id

Id string: Resource Id

id String: Resource Id

id string: Resource Id

id str: Resource Id

id String: Resource Id

SystemDataResponse

CreatedAt string: Specifies the time in UTC at which the Cloud Service (extended support) resource was created. Minimum api-version: 2022-04-04.
LastModifiedAt string: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. Minimum api-version: 2022-04-04.

CreatedAt string: Specifies the time in UTC at which the Cloud Service (extended support) resource was created. Minimum api-version: 2022-04-04.
LastModifiedAt string: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. Minimum api-version: 2022-04-04.

createdAt String: Specifies the time in UTC at which the Cloud Service (extended support) resource was created. Minimum api-version: 2022-04-04.
lastModifiedAt String: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. Minimum api-version: 2022-04-04.

createdAt string: Specifies the time in UTC at which the Cloud Service (extended support) resource was created. Minimum api-version: 2022-04-04.
lastModifiedAt string: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. Minimum api-version: 2022-04-04.

created_at str: Specifies the time in UTC at which the Cloud Service (extended support) resource was created. Minimum api-version: 2022-04-04.
last_modified_at str: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. Minimum api-version: 2022-04-04.

createdAt String: Specifies the time in UTC at which the Cloud Service (extended support) resource was created. Minimum api-version: 2022-04-04.
lastModifiedAt String: Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. Minimum api-version: 2022-04-04.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.compute.getCloudService

On this page

On this page

Using getCloudService

getCloudService Result

Supporting Types

CloudServiceExtensionProfileResponse

CloudServiceExtensionPropertiesResponse

CloudServiceNetworkProfileResponse

CloudServiceOsProfileResponse

CloudServicePropertiesResponse

CloudServiceRoleProfilePropertiesResponse

CloudServiceRoleProfileResponse

CloudServiceRoleSkuResponse

CloudServiceVaultAndSecretReferenceResponse

CloudServiceVaultCertificateResponse

CloudServiceVaultSecretGroupResponse

ExtensionResponse

LoadBalancerConfigurationPropertiesResponse

LoadBalancerConfigurationResponse

LoadBalancerFrontendIpConfigurationPropertiesResponse

LoadBalancerFrontendIpConfigurationResponse

SubResourceResponse

SystemDataResponse

Package Details

On this page

On this page