Feedback Edit

DataBoxEdgeManagementClient Class

  • Reference

The DataBoxEdge 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
DataBoxEdgeManagementClient
azure.mgmt.databoxedge._data_box_edge_management_client._SDKClient
DataBoxEdgeManagementClient

Constructor

DataBoxEdgeManagementClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)

Parameters

credential
TokenCredential
Required

Credential needed for the client to connect to Azure.

subscription_id
str
Required

The subscription ID.

api_version
str
default value: None

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

base_url
str
default value: None

Service URL

profile
KnownProfiles
default value: KnownProfiles.default

A profile definition, from KnownProfiles to dict.

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='2020-09-01')

Parameters

cls
Required
api_version
default value: 2020-09-01

Attributes

addons

Instance depends on the API version:

alerts

Instance depends on the API version:

available_skus

Instance depends on the API version:

bandwidth_schedules

Instance depends on the API version:

containers

Instance depends on the API version:

devices

Instance depends on the API version:

jobs

Instance depends on the API version:

monitoring_config

Instance depends on the API version:

nodes

Instance depends on the API version:

operations

Instance depends on the API version:

operations_status

Instance depends on the API version:

orders

Instance depends on the API version:

roles

Instance depends on the API version:

shares

Instance depends on the API version:

skus

Instance depends on the API version:

storage_account_credentials

Instance depends on the API version:

storage_accounts

Instance depends on the API version:

triggers

Instance depends on the API version:

users

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2020-09-01'

LATEST_PROFILE 

LATEST_PROFILE = azure.mgmt.databoxedge.DataBoxEdgeManagementClient latest