Custom Locations - Update

Referencia

Szolgáltatás:: Extended Location

API-verzió:: 2021-08-15

Frissíti az egyéni helyet a megadott erőforráscsoportban és előfizetésben megadott erőforrásnévvel.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ExtendedLocation/customLocations/{resourceName}?api-version=2021-08-15

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	Egyéni helyek neve.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Típus	Description
identity	Identity	Az erőforrás identitása.
properties.authentication	Authentication	Ez nem kötelező bemenet, amely tartalmazza a névtér létrehozásához használni kívánt hitelesítést.
properties.clusterExtensionIds	string[]	A CRD-k és operátorok üzembe helyezéséhez diagramokat tartalmazó bővítményre mutató hivatkozást tartalmaz.
properties.displayName	string	Az egyéni helyek helyének megjelenítendő neve.
properties.hostResourceId	string	Csatlakoztatott fürt vagy AKS-fürt. Az egyéni helyek RP-jének a listAdminCredentials engedélyeinek checkAccess API-ja lesz végrehajtva.
properties.hostType	HostType	Az egyéni helyekre hivatkozó gazdagép típusa (Kubernetes stb.).
properties.namespace	string	A megadott fürtön létrejövő Kubernetes-névtér.
properties.provisioningState	string	Az egyéni hely kiépítési állapota.
tags	object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	customLocation	OKÉ
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Update Custom Location

Mintakérelem

PATCH https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ExtendedLocation/customLocations/customLocation01?api-version=2021-08-15

{
  "properties": {
    "clusterExtensionIds": [
      "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension",
      "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension"
    ]
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "tags": {
    "tier": "testing",
    "archv3": ""
  }
}


import com.azure.resourcemanager.extendedlocation.models.CustomLocation;
import com.azure.resourcemanager.extendedlocation.models.Identity;
import com.azure.resourcemanager.extendedlocation.models.ResourceIdentityType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for CustomLocations Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/
     * CustomLocationsPatch.json
     */
    /**
     * Sample code: Update Custom Location.
     * 
     * @param manager Entry point to CustomLocationsManager.
     */
    public static void updateCustomLocation(com.azure.resourcemanager.extendedlocation.CustomLocationsManager manager) {
        CustomLocation resource = manager.customLocations()
            .getByResourceGroupWithResponse("testresourcegroup", "customLocation01", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withTags(mapOf("archv3", "", "tier", "testing"))
            .withIdentity(new Identity().withType(ResourceIdentityType.SYSTEM_ASSIGNED))
            .withClusterExtensionIds(Arrays.asList(
                "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension",
                "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension"))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.extendedlocation import CustomLocations

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-extendedlocation
# USAGE
    python custom_locations_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CustomLocations(
        credential=DefaultAzureCredential(),
        subscription_id="11111111-2222-3333-4444-555555555555",
    )

    response = client.custom_locations.update(
        resource_group_name="testresourcegroup",
        resource_name="customLocation01",
    )
    print(response)


# x-ms-original-file: specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsPatch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armextendedlocation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsPatch.json
func ExampleCustomLocationsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomLocationsClient().Update(ctx, "testresourcegroup", "customLocation01", armextendedlocation.PatchableCustomLocations{
		Identity: &armextendedlocation.Identity{
			Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		},
		Properties: &armextendedlocation.CustomLocationProperties{
			ClusterExtensionIDs: []*string{
				to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"),
				to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension")},
		},
		Tags: map[string]*string{
			"archv3": to.Ptr(""),
			"tier":   to.Ptr("testing"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomLocation = armextendedlocation.CustomLocation{
	// 	Name: to.Ptr("customLocation01"),
	// 	Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
	// 	ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"archv3": to.Ptr(""),
	// 		"tier": to.Ptr("testing"),
	// 	},
	// 	Identity: &armextendedlocation.Identity{
	// 		Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 		TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
	// 	},
	// 	Properties: &armextendedlocation.CustomLocationProperties{
	// 		Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
	// 			Type: to.Ptr("KubeConfig"),
	// 		},
	// 		ClusterExtensionIDs: []*string{
	// 			to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"),
	// 			to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension")},
	// 			DisplayName: to.Ptr("customLocationLocation01"),
	// 			HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
	// 			Namespace: to.Ptr("namespace01"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 		},
	// 		SystemData: &armextendedlocation.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
	// 			CreatedBy: to.Ptr("string"),
	// 			CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("string"),
	// 			LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ExtendedLocations.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.ExtendedLocations;

// Generated from example definition: specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsPatch.json
// this example is just showing the usage of "CustomLocations_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CustomLocationResource created on azure
// for more information of creating CustomLocationResource, please refer to the document of CustomLocationResource
string subscriptionId = "11111111-2222-3333-4444-555555555555";
string resourceGroupName = "testresourcegroup";
string resourceName = "customLocation01";
ResourceIdentifier customLocationResourceId = CustomLocationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
CustomLocationResource customLocation = client.GetCustomLocationResource(customLocationResourceId);

// invoke the operation
CustomLocationPatch patch = new CustomLocationPatch
{
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    Tags =
    {
    ["archv3"] = "",
    ["tier"] = "testing"
    },
    ClusterExtensionIds = { new ResourceIdentifier("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"), new ResourceIdentifier("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension") },
};
CustomLocationResource result = await customLocation.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CustomLocationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

{
  "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01",
  "name": "customLocation01",
  "type": "Microsoft.ExtendedLocation/customLocations",
  "location": "West US",
  "tags": {
    "tier": "testing",
    "archv3": ""
  },
  "properties": {
    "hostResourceId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01",
    "namespace": "namespace01",
    "displayName": "customLocationLocation01",
    "provisioningState": "Succeeded",
    "clusterExtensionIds": [
      "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension",
      "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension"
    ],
    "authentication": {
      "type": "KubeConfig"
    }
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "11111111-1111-1111-1111-111111111111",
    "tenantId": "111111-1111-1111-1111-111111111111"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-08-24T18:53:29.0928001Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-08-24T18:53:29.0928001Z"
  }
}

Definíciók

Name	Description
Authentication	Ez nem kötelező bemenet, amely tartalmazza a névtér létrehozásához használni kívánt hitelesítést.
createdByType	Az erőforrást létrehozó identitás típusa.
customLocation	Egyéni helyek definíciója.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
HostType	Az egyéni helyekre hivatkozó gazdagép típusa (Kubernetes stb.).
Identity	Az erőforrás identitása.
patchableCustomLocations	Az egyéni helyek javítható erőforrásdefiníciója.
ResourceIdentityType	Az identitás típusa.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Authentication

Objektum

Ez nem kötelező bemenet, amely tartalmazza a névtér létrehozásához használni kívánt hitelesítést.

Name	Típus	Description
type	string	Az egyéni helyek hitelesítésének típusa
value	string	A kubeconfig érték.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

customLocation

Objektum

Egyéni helyek definíciója.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	Az erőforrás identitása.
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.authentication	Authentication	Ez nem kötelező bemenet, amely tartalmazza a névtér létrehozásához használni kívánt hitelesítést.
properties.clusterExtensionIds	string[]	A CRD-k és operátorok üzembe helyezéséhez diagramokat tartalmazó bővítményre mutató hivatkozást tartalmaz.
properties.displayName	string	Az egyéni helyek helyének megjelenítendő neve.
properties.hostResourceId	string	Csatlakoztatott fürt vagy AKS-fürt. Az egyéni helyek RP-jének a listAdminCredentials engedélyeinek checkAccess API-ja lesz végrehajtva.
properties.hostType	HostType	Az egyéni helyekre hivatkozó gazdagép típusa (Kubernetes stb.).
properties.namespace	string	A megadott fürtön létrejövő Kubernetes-névtér.
properties.provisioningState	string	Az egyéni hely kiépítési állapota.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

HostType

Enumerálás

Az egyéni helyekre hivatkozó gazdagép típusa (Kubernetes stb.).

Érték	Description
Kubernetes

Identity

Objektum

Az erőforrás identitása.

Name	Típus	Description
principalId	string	Az erőforrás-identitás egyszerű azonosítója.
tenantId	string	Az erőforrás bérlőazonosítója.
type	ResourceIdentityType	Az identitás típusa.

patchableCustomLocations

Objektum

Az egyéni helyek javítható erőforrásdefiníciója.

Name	Típus	Description
identity	Identity	Az erőforrás identitása.
properties.authentication	Authentication	Ez nem kötelező bemenet, amely tartalmazza a névtér létrehozásához használni kívánt hitelesítést.
properties.clusterExtensionIds	string[]	A CRD-k és operátorok üzembe helyezéséhez diagramokat tartalmazó bővítményre mutató hivatkozást tartalmaz.
properties.displayName	string	Az egyéni helyek helyének megjelenítendő neve.
properties.hostResourceId	string	Csatlakoztatott fürt vagy AKS-fürt. Az egyéni helyek RP-jének a listAdminCredentials engedélyeinek checkAccess API-ja lesz végrehajtva.
properties.hostType	HostType	Az egyéni helyekre hivatkozó gazdagép típusa (Kubernetes stb.).
properties.namespace	string	A megadott fürtön létrejövő Kubernetes-névtér.
properties.provisioningState	string	Az egyéni hely kiépítési állapota.
tags	object	Erőforráscímkék

ResourceIdentityType

Enumerálás

Az identitás típusa.

Érték	Description
None
SystemAssigned

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Custom Locations - Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Update Custom Location

Mintakérelem

Mintaválasz

Definíciók

Authentication

createdByType

customLocation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostType

Identity

patchableCustomLocations

ResourceIdentityType

systemData