Share via

ComputeManagementClient Class

  • Reference

Compute Client.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Inheritance
MultiApiClientMixin
ComputeManagementClient
azure.mgmt.compute._compute_management_client._SDKClient
ComputeManagementClient

Constructor

ComputeManagementClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name Description
credential
Required
TokenCredential

Credential needed for the client to connect to Azure. Required.
subscription_id
Required
str

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. Required.
api_version
str

API version to use if no profile is provided, or if missing in profile.

Default value: None
base_url
str

Service URL

Default value: https://management.azure.com
profile
KnownProfiles

A profile definition, from KnownProfiles to dict.

Default value: KnownProfiles.default

Keyword-Only Parameters

Name Description
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Methods

close
models

Module depends on the API version:

close 

close()

models

Module depends on the API version:

models(api_version='2024-07-01')

Parameters

Name Description
api_version
Default value: 2024-07-01

Attributes

availability_sets

Instance depends on the API version:

capacity_reservation_groups

Instance depends on the API version:

capacity_reservations

Instance depends on the API version:

cloud_service_operating_systems

Instance depends on the API version:

cloud_service_role_instances

Instance depends on the API version:

cloud_service_roles

Instance depends on the API version:

cloud_services

Instance depends on the API version:

cloud_services_update_domain

Instance depends on the API version:

community_galleries

Instance depends on the API version:

Instance depends on the API version:

Instance depends on the API version:

dedicated_host_groups

Instance depends on the API version:

dedicated_hosts

Instance depends on the API version:

disk_accesses

Instance depends on the API version:

disk_encryption_sets

Instance depends on the API version:

disk_restore_point

Instance depends on the API version:

disks

Instance depends on the API version:

galleries

Instance depends on the API version:

Instance depends on the API version:

Instance depends on the API version:

Instance depends on the API version:

Instance depends on the API version:

Instance depends on the API version:

images

Instance depends on the API version:

log_analytics

Instance depends on the API version:

operations

Instance depends on the API version:

proximity_placement_groups

Instance depends on the API version:

resource_skus

Instance depends on the API version:

restore_point_collections

Instance depends on the API version:

restore_points

Instance depends on the API version:

shared_galleries

Instance depends on the API version:

Instance depends on the API version:

Instance depends on the API version:

snapshots

Instance depends on the API version:

ssh_public_keys

Instance depends on the API version:

usage

Instance depends on the API version:

virtual_machine_extension_images

Instance depends on the API version:

virtual_machine_extensions

Instance depends on the API version:

virtual_machine_images

Instance depends on the API version:

virtual_machine_images_edge_zone

Instance depends on the API version:

virtual_machine_run_commands

Instance depends on the API version:

virtual_machine_scale_set_extensions

Instance depends on the API version:

virtual_machine_scale_set_rolling_upgrades

Instance depends on the API version:

virtual_machine_scale_set_vm_extensions

Instance depends on the API version:

virtual_machine_scale_set_vm_run_commands

Instance depends on the API version:

virtual_machine_scale_set_vms

Instance depends on the API version:

virtual_machine_scale_sets

Instance depends on the API version:

virtual_machine_sizes

Instance depends on the API version:

virtual_machines

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2024-07-01'

LATEST_PROFILE 

LATEST_PROFILE = azure.mgmt.compute.ComputeManagementClient latest