azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations
name: CloudServicesOperations
fullName: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations
module: azure.mgmt.compute.v2020_10_01_preview.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2020_10_01_preview.ComputeManagementClient>'s\n\
  >\n> <xref:cloud_services> attribute.\n>"
constructor:
  syntax: CloudServicesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_create_or_update
  name: begin_create_or_update
  summary: 'Create or update a cloud service. Please note some properties can be set
    only during cloud

    service creation.'
  signature: 'begin_create_or_update(resource_group_name: str, cloud_service_name:
    str, parameters: _models.CloudService | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[_models.CloudService]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The cloud service object. Is either a CloudService type or a IO[bytes]
      type.

      Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudService>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either CloudService or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudService>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_delete
  name: begin_delete
  summary: Deletes a cloud service.
  signature: 'begin_delete(resource_group_name: str, cloud_service_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_delete_instances
  name: begin_delete_instances
  summary: Deletes role instances in a cloud service.
  signature: 'begin_delete_instances(resource_group_name: str, cloud_service_name:
    str, parameters: _models.RoleInstances | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'List of cloud service role instance names. Is either a RoleInstances
      type or

      a IO[bytes] type. Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.RoleInstances>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_power_off
  name: begin_power_off
  summary: 'Power off the cloud service. Note that resources are still attached and
    you are getting charged

    for the resources.'
  signature: 'begin_power_off(resource_group_name: str, cloud_service_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_rebuild
  name: begin_rebuild
  summary: 'Rebuild Role Instances reinstalls the operating system on instances of
    web roles or worker

    roles and initializes the storage resources that are used by them. If you do not
    want to

    initialize storage resources, you can use Reimage Role Instances.'
  signature: 'begin_rebuild(resource_group_name: str, cloud_service_name: str, parameters:
    _models.RoleInstances | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'List of cloud service role instance names. Is either a RoleInstances
      type or

      a IO[bytes] type. Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.RoleInstances>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_reimage
  name: begin_reimage
  summary: 'Reimage asynchronous operation reinstalls the operating system on instances
    of web roles or

    worker roles.'
  signature: 'begin_reimage(resource_group_name: str, cloud_service_name: str, parameters:
    _models.RoleInstances | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'List of cloud service role instance names. Is either a RoleInstances
      type or

      a IO[bytes] type. Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.RoleInstances>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_restart
  name: begin_restart
  summary: Restarts one or more role instances in a cloud service.
  signature: 'begin_restart(resource_group_name: str, cloud_service_name: str, parameters:
    _models.RoleInstances | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'List of cloud service role instance names. Is either a RoleInstances
      type or

      a IO[bytes] type. Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.RoleInstances>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_start
  name: begin_start
  summary: Starts the cloud service.
  signature: 'begin_start(resource_group_name: str, cloud_service_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.begin_update
  name: begin_update
  summary: Update a cloud service.
  signature: 'begin_update(resource_group_name: str, cloud_service_name: str, parameters:
    _models.CloudServiceUpdate | None = None, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[_models.CloudService]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The cloud service object. Is either a CloudServiceUpdate type or
      a IO[bytes]

      type. Default value is None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudServiceUpdate>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either CloudService or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudService>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.get
  name: get
  summary: Display information about a cloud service.
  signature: 'get(resource_group_name: str, cloud_service_name: str, **kwargs: Any)
    -> CloudService'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CloudService or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudService>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.get_instance_view
  name: get_instance_view
  summary: Gets the status of a cloud service.
  signature: 'get_instance_view(resource_group_name: str, cloud_service_name: str,
    **kwargs: Any) -> CloudServiceInstanceView'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: cloud_service_name
    description: Name of the cloud service. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CloudServiceInstanceView or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudServiceInstanceView>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.list
  name: list
  summary: 'Gets a list of all cloud services under a resource group. Use nextLink
    property in the response

    to get the next page of Cloud Services. Do this till nextLink is null to fetch
    all the Cloud

    Services.'
  signature: 'list(resource_group_name: str, **kwargs: Any) -> Iterable[CloudService]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either CloudService or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudService>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.list_all
  name: list_all
  summary: 'Gets a list of all cloud services in the subscription, regardless of the
    associated resource

    group. Use nextLink property in the response to get the next page of Cloud Services.
    Do this

    till nextLink is null to fetch all the Cloud Services.'
  signature: 'list_all(**kwargs: Any) -> Iterable[CloudService]'
  return:
    description: An iterator like instance of either CloudService or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2020_10_01_preview.models.CloudService>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2020_10_01_preview.operations.CloudServicesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2020_10_01_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2020_10_01_preview\\models\\__init__.py'>