CustomLocationsOperations Class

  • Reference

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.

begin_create_or_update(resource_group_name: str, resource_name: str, parameters: _models.CustomLocation, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CustomLocation]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
resource_name
Required
str

Custom Locations name. Required.
parameters
Required
CustomLocation or IO

Parameters supplied to create or update a Custom Location. Is either a CustomLocation type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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 PollingMethod

By default, your polling method will be ARMPolling. 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

Type Description
LROPoller[CustomLocation]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a Custom Location.

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

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
resource_name
Required
str

Custom Locations name. Required.

Keyword-Only Parameters

Name Description
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 PollingMethod

By default, your polling method will be ARMPolling. 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

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Gets a Custom Location.

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

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> CustomLocation

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
resource_name
Required
str

Custom Locations name. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
CustomLocation

CustomLocation or the result of cls(response)

Exceptions

Type Description
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) -> Iterable[CustomLocation]

Parameters

Name Description
resource_group_name
Required
str

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[CustomLocation]

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

Exceptions

Type Description
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) -> Iterable[CustomLocation]

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[CustomLocation]

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

Exceptions

Type Description
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) -> Iterable[EnabledResourceType]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
resource_name
Required
str

Custom Locations name. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[EnabledResourceType]

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

Exceptions

Type Description
HttpResponseError

list_operations

Lists all available Custom Locations operations.

list_operations(**kwargs: Any) -> Iterable[CustomLocationOperation]

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[CustomLocationOperation]

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

Exceptions

Type Description
HttpResponseError

update

Updates a Custom Location.

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

update(resource_group_name: str, resource_name: str, tags: Dict[str, str] | None = None, authentication: CustomLocationPropertiesAuthentication | None = None, cluster_extension_ids: List[str] | None = None, display_name: str | None = None, host_resource_id: str | None = None, host_type: str | HostType | None = None, namespace: str | None = None, provisioning_state: str | None = None, **kwargs: Any) -> CustomLocation

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
resource_name
Required
str

Custom Locations name. Required.
tags
Required
dict[str, str]

Resource tags. Default value is None.
authentication
Required
CustomLocationPropertiesAuthentication

This is optional input that contains the authentication that should be used to generate the namespace. Default value is None.
cluster_extension_ids
Required
list[str]

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

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

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

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

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

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
CustomLocation

CustomLocation or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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