Microsoft.ExtendedLocation (stable:2021-08-15)

2025/09/26 • 8 new, 8 deleted methods

CustomLocations_ListOperations (new)
Description :  Lists all available Custom Locations operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ExtendedLocation/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: Array of customLocationOperation ,
Required: True ,
}
[
{
display:
{
Description: Describes the properties of a Custom Locations Operation Value Display. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Is this Operation a data plane operation ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
origin:
{
Description: The origin of the compute operation. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListBySubscription (new)
Description :  Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ExtendedLocation/customLocations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Custom Locations. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListByResourceGroup (new)
Description :  Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Custom Locations. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_Get (new)
Description :  Gets the details of the customLocation with a specified resource group and name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_CreateOrUpdate (new)
Description :  Creates or updates a Custom Location in the specified Subscription and Resource Group
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update a Custom Location. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_Delete (new)
Description :  Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_Update (new)
Description :  Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
parameters:
{
Description: The updatable fields of an existing Custom Location. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Custom Locations patchable properties. ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListEnabledResourceTypes (new)
Description :  Gets the list of the Enabled Resource Types.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}/enabledResourceTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of EnabledResourceTypes available for a customLocation. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties for EnabledResourceType specific to a Custom Location ,
Required: False ,
}
{
clusterExtensionId:
{
Description: Cluster Extension ID ,
Required: False ,
}
string ,
extensionType:
{
Description: Cluster Extension Type ,
Required: False ,
}
string ,
typesMetadata:
{
Description: Metadata of the Resource Type ,
Required: False ,
}
[
{
apiVersion:
{
Description: Api Version of Resource Type ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: Resource Provider Namespace of Resource Type ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListOperations (removed)
Description :  Lists all available Custom Locations operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ExtendedLocation/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: Array of customLocationOperation ,
Required: True ,
}
[
{
display:
{
Description: Describes the properties of a Custom Locations Operation Value Display. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Is this Operation a data plane operation ,
Required: False ,
}
boolean ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
origin:
{
Description: The origin of the compute operation. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListBySubscription (removed)
Description :  Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ExtendedLocation/customLocations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Custom Locations. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListByResourceGroup (removed)
Description :  Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of Custom Locations. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_Get (removed)
Description :  Gets the details of the customLocation with a specified resource group and name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_CreateOrUpdate (removed)
Description :  Creates or updates a Custom Location in the specified Subscription and Resource Group
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update a Custom Location. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_Delete (removed)
Description :  Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_Update (removed)
Description :  Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
parameters:
{
Description: The updatable fields of an existing Custom Location. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The Custom Locations patchable properties. ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The set of properties specific to a Custom Location ,
Required: False ,
}
{
authentication:
{
Description: This is optional input that contains the authentication that should be used to generate the namespace. ,
Required: False ,
}
{
type:
{
Description: The type of the Custom Locations authentication ,
Required: False ,
}
string ,
value:
{
Description: The kubeconfig value. ,
Required: False ,
}
string ,
}
,
clusterExtensionIds:
{
Description: Contains the reference to the add-on that contains charts to deploy CRDs and operators. ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name for the Custom Locations location. ,
Required: False ,
}
string ,
hostResourceId:
{
Description: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. ,
Required: False ,
}
string ,
hostType:
{
Description: Type of host the Custom Locations is referencing (Kubernetes, etc...). ,
Enum:
{
Kubernetes: No description available. ,
}
,
Required: False ,
}
enum ,
namespace:
{
Description: Kubernetes namespace that will be created on the specified cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State for the Custom Location. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomLocations_ListEnabledResourceTypes (removed)
Description :  Gets the list of the Enabled Resource Types.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}/enabledResourceTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: Custom Locations name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of EnabledResourceTypes available for a customLocation. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties for EnabledResourceType specific to a Custom Location ,
Required: False ,
}
{
clusterExtensionId:
{
Description: Cluster Extension ID ,
Required: False ,
}
string ,
extensionType:
{
Description: Cluster Extension Type ,
Required: False ,
}
string ,
typesMetadata:
{
Description: Metadata of the Resource Type ,
Required: False ,
}
[
{
apiVersion:
{
Description: Api Version of Resource Type ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: Resource Provider Namespace of Resource Type ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Type ,
Required: False ,
}
string ,
}
,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}