Feedback Edit

VnetClient Class

  • Reference

VnetClient.

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
VnetClient
azure.synapse.managedprivateendpoints._vnet_client._SDKClient
VnetClient

Constructor

VnetClient(credential, endpoint, api_version='2020-12-01', profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)

Parameters

credential
TokenCredential
Required

Credential needed for the client to connect to Azure.

endpoint
str
Required

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.

api_version
str
default value: 2020-12-01

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

profile
KnownProfiles
default value: KnownProfiles.default

A profile definition, from KnownProfiles to dict.

Methods

close
models

Module depends on the API version:

close 

close()

models

Module depends on the API version:

models(api_version='2020-12-01')

Parameters

cls
Required
api_version
default value: 2020-12-01

Attributes

managed_private_endpoints

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2020-12-01'

LATEST_PROFILE 

LATEST_PROFILE = azure.synapse.managedprivateendpoints.VnetClient latest