CustomLocationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CustomLocations's

<xref:custom_locations> attribute.

Inheritance

builtins.object

CustomLocationsOperations

Constructor

CustomLocationsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a Custom Location. Creates or updates a Custom Location in the specified Subscription and Resource Group.
begin_delete	Deletes a Custom Location. Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
get	Gets a Custom Location. Gets the details of the customLocation with a specified resource group and name.
list_by_resource_group	Gets a list of Custom Locations in the specified subscription and resource group. Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.
list_by_subscription	Gets a list of Custom Locations in a subscription. Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location.
list_enabled_resource_types	Gets the list of Enabled Resource Types. Gets the list of the Enabled Resource Types.
list_operations	Lists all available Custom Locations operations.
update	Updates a Custom Location. Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.

begin_create_or_update

Creates or updates a Custom Location.

Creates or updates a Custom Location in the specified Subscription and Resource Group.

async begin_create_or_update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocation, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocation]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

Custom Locations name.

parameters

CustomLocation

Required

Parameters supplied to create or update a Custom Location.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

An instance of AsyncLROPoller that returns either CustomLocation or the result of cls(response)

Return type

AsyncLROPoller[CustomLocation]

Exceptions

HttpResponseError

begin_delete

Deletes a Custom Location.

Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.

async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

Custom Locations name.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Gets a Custom Location.

Gets the details of the customLocation with a specified resource group and name.

async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocation

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

Custom Locations name.

cls

callable

A custom type or function that will be passed the direct response

Returns

CustomLocation, or the result of cls(response)

Return type

CustomLocation

Exceptions

HttpResponseError

list_by_resource_group

Gets a list of Custom Locations in the specified subscription and resource group.

Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocationListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CustomLocationListResult or the result of cls(response)

Return type

AsyncItemPaged[CustomLocationListResult]

Exceptions

HttpResponseError

list_by_subscription

Gets a list of Custom Locations in a subscription.

Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocationListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CustomLocationListResult or the result of cls(response)

Return type

AsyncItemPaged[CustomLocationListResult]

Exceptions

HttpResponseError

list_enabled_resource_types

Gets the list of Enabled Resource Types.

Gets the list of the Enabled Resource Types.

list_enabled_resource_types(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.EnabledResourceTypesListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

Custom Locations name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EnabledResourceTypesListResult or the result of cls(response)

Return type

AsyncItemPaged[EnabledResourceTypesListResult]

Exceptions

HttpResponseError

list_operations

Lists all available Custom Locations operations.

list_operations(**kwargs: Any) -> AsyncIterable[azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocationOperationsList]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CustomLocationOperationsList or the result of cls(response)

Return type

AsyncItemPaged[CustomLocationOperationsList]

Exceptions

HttpResponseError

update

Updates a Custom Location.

Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.

async update(resource_group_name: str, resource_name: str, tags: Optional[Dict[str, str]] = None, authentication: Optional[azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocationPropertiesAuthentication] = None, cluster_extension_ids: Optional[List[str]] = None, display_name: Optional[str] = None, host_resource_id: Optional[str] = None, host_type: Optional[Union[str, azure.mgmt.extendedlocation.v2021_03_15_preview.models._custom_locations_enums.HostType]] = None, namespace: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs: Any) -> azure.mgmt.extendedlocation.v2021_03_15_preview.models._models_py3.CustomLocation

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

Custom Locations name.

tags

dict[str, str]

Required

Resource tags. Default value is None.

authentication

CustomLocationPropertiesAuthentication

Required

This is optional input that contains the authentication that should be used to generate the namespace. Default value is None.

cluster_extension_ids

list[str]

Required

Contains the reference to the add-on that contains charts to deploy CRDs and operators. Default value is None.

display_name

str

Required

Display name for the Custom Locations location. Default value is None.

host_resource_id

str

Required

Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. Default value is None.

host_type

str or HostType

Required

Type of host the Custom Locations is referencing (Kubernetes, etc...). Default value is None.

namespace

str

Required

Kubernetes namespace that will be created on the specified cluster. Default value is None.

provisioning_state

str

Required

Provisioning State for the Custom Location. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

CustomLocation, or the result of cls(response)

Return type

CustomLocation

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.extendedlocation.v2021_03_15_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\extendedlocation\\v2021_03_15_preview\\models\\__init__.py'>