azure.mgmt.compute.v2023_10_02.operations.DisksOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations
name: DisksOperations
fullName: azure.mgmt.compute.v2023_10_02.operations.DisksOperations
module: azure.mgmt.compute.v2023_10_02.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.v2023_10_02.ComputeManagementClient>'s\n\
  >\n> <xref:disks> attribute.\n>"
constructor:
  syntax: DisksOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Creates or updates a disk.
  signature: 'begin_create_or_update(resource_group_name: str, disk_name: str, disk:
    _models.Disk, *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.Disk]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: disk_name
    description: 'The name of the managed disk that is being created. The name can''t
      be changed

      after the disk is created. Supported characters for the name are a-z, A-Z, 0-9,
      _ and -. The

      maximum name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: disk
    description: 'Disk object supplied in the body of the Put disk operation. Is either
      a Disk type

      or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_10_02.models.Disk>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either Disk or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_10_02.models.Disk>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.begin_delete
  name: begin_delete
  summary: Deletes a disk.
  signature: 'begin_delete(resource_group_name: str, disk_name: str, **kwargs: Any)
    -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: disk_name
    description: 'The name of the managed disk that is being created. The name can''t
      be changed

      after the disk is created. Supported characters for the name are a-z, A-Z, 0-9,
      _ and -. The

      maximum name length is 80 characters. 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.v2023_10_02.operations.DisksOperations.begin_grant_access
  name: begin_grant_access
  summary: Grants access to a disk.
  signature: 'begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data:
    _models.GrantAccessData, *, content_type: str = ''application/json'', **kwargs:
    Any) -> LROPoller[_models.AccessUri]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: disk_name
    description: 'The name of the managed disk that is being created. The name can''t
      be changed

      after the disk is created. Supported characters for the name are a-z, A-Z, 0-9,
      _ and -. The

      maximum name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: grant_access_data
    description: 'Access data object supplied in the body of the get disk access

      operation. Is either a GrantAccessData type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_10_02.models.GrantAccessData>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either AccessUri or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_10_02.models.AccessUri>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.begin_revoke_access
  name: begin_revoke_access
  summary: Revokes access to a disk.
  signature: 'begin_revoke_access(resource_group_name: str, disk_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: disk_name
    description: 'The name of the managed disk that is being created. The name can''t
      be changed

      after the disk is created. Supported characters for the name are a-z, A-Z, 0-9,
      _ and -. The

      maximum name length is 80 characters. 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.v2023_10_02.operations.DisksOperations.begin_update
  name: begin_update
  summary: Updates (patches) a disk.
  signature: 'begin_update(resource_group_name: str, disk_name: str, disk: _models.DiskUpdate,
    *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.Disk]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: disk_name
    description: 'The name of the managed disk that is being created. The name can''t
      be changed

      after the disk is created. Supported characters for the name are a-z, A-Z, 0-9,
      _ and -. The

      maximum name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: disk
    description: 'Disk object supplied in the body of the Patch disk operation. Is
      either a

      DiskUpdate type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_10_02.models.DiskUpdate>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either Disk or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2023_10_02.models.Disk>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.get
  name: get
  summary: Gets information about a disk.
  signature: 'get(resource_group_name: str, disk_name: str, **kwargs: Any) -> Disk'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: disk_name
    description: 'The name of the managed disk that is being created. The name can''t
      be changed

      after the disk is created. Supported characters for the name are a-z, A-Z, 0-9,
      _ and -. The

      maximum name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: Disk or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_10_02.models.Disk>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.list
  name: list
  summary: Lists all the disks under a subscription.
  signature: 'list(**kwargs: Any) -> Iterable[Disk]'
  return:
    description: An iterator like instance of either Disk or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2023_10_02.models.Disk>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Lists all the disks under a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Disk]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either Disk or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2023_10_02.models.Disk>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2023_10_02.operations.DisksOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2023_10_02.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2023_10_02\\models\\__init__.py'>