Local Users - Create Or Update

Başvuru

Service:: Storage Resource Provider

API Version:: 2023-01-01

Depolama hesabıyla ilişkili yerel kullanıcının özelliklerini oluşturma veya güncelleştirme

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}?api-version=2023-01-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string	Belirtilen kaynak grubundaki depolama hesabının adı. Depolama hesabı adları 3 ila 24 karakter uzunluğunda olmalı ve yalnızca sayıları ve küçük harfleri kullanmalıdır. Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	Kullanıcının aboneliğindeki kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
username	path	True	string	Yerel kullanıcının adı. Kullanıcı adı yalnızca küçük harf ve sayı içermelidir. Yalnızca depolama hesabı içinde benzersiz olmalıdır.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.hasSharedKey	boolean	Paylaşılan anahtarın mevcut olup olmadığını gösterir. Mevcut paylaşılan anahtarı kaldırmak için false olarak ayarlayın.
properties.hasSshKey	boolean	SSH anahtarının mevcut olup olmadığını gösterir. Mevcut SSH anahtarını kaldırmak için false olarak ayarlayın.
properties.hasSshPassword	boolean	SSH parolasının mevcut olup olmadığını gösterir. Mevcut SSH parolasını kaldırmak için false olarak ayarlayın.
properties.homeDirectory	string	İsteğe bağlı, yerel kullanıcı giriş dizini.
properties.permissionScopes	PermissionScope[]	Yerel kullanıcının izin kapsamları.
properties.sshAuthorizedKeys	SshPublicKey[]	İsteğe bağlı, SFTP için yerel kullanıcı ssh yetkili anahtarları.

Yanıtlar

Name	Tür	Description
200 OK	LocalUser	Tamam -- Yerel kullanıcıyı başarıyla yerleştirin.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

CreateLocalUser

UpdateLocalUser

CreateLocalUser

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers/user1?api-version=2023-01-01

{
  "properties": {
    "permissionScopes": [
      {
        "permissions": "rwd",
        "service": "file",
        "resourceName": "share1"
      },
      {
        "permissions": "rw",
        "service": "file",
        "resourceName": "share2"
      }
    ],
    "homeDirectory": "homedirectory",
    "hasSshPassword": true,
    "sshAuthorizedKeys": [
      {
        "description": "key name",
        "key": "ssh-rsa keykeykeykeykey="
      }
    ]
  }
}


import com.azure.resourcemanager.storage.fluent.models.LocalUserInner;
import com.azure.resourcemanager.storage.models.PermissionScope;
import com.azure.resourcemanager.storage.models.SshPublicKey;
import java.util.Arrays;

/** Samples for LocalUsersOperation CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserCreate.json
     */
    /**
     * Sample code: CreateLocalUser.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createLocalUser(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getLocalUsersOperations().createOrUpdateWithResponse(
            "res6977", "sto2527", "user1",
            new LocalUserInner()
                .withPermissionScopes(Arrays.asList(
                    new PermissionScope().withPermissions("rwd").withService("file").withResourceName("share1"),
                    new PermissionScope().withPermissions("rw").withService("file").withResourceName("share2")))
                .withHomeDirectory("homedirectory")
                .withSshAuthorizedKeys(
                    Arrays.asList(new SshPublicKey().withDescription("key name").withKey("fakeTokenPlaceholder")))
                .withHasSshPassword(true),
            com.azure.core.util.Context.NONE);
    }
}

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.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python local_user_create.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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.local_users.create_or_update(
        resource_group_name="res6977",
        account_name="sto2527",
        username="user1",
        properties={
            "properties": {
                "hasSshPassword": True,
                "homeDirectory": "homedirectory",
                "permissionScopes": [
                    {"permissions": "rwd", "resourceName": "share1", "service": "file"},
                    {"permissions": "rw", "resourceName": "share2", "service": "file"},
                ],
                "sshAuthorizedKeys": [{"description": "key name", "key": "ssh-rsa keykeykeykeykey="}],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserCreate.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 armstorage_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/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserCreate.json
func ExampleLocalUsersClient_CreateOrUpdate_createLocalUser() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLocalUsersClient().CreateOrUpdate(ctx, "res6977", "sto2527", "user1", armstorage.LocalUser{
		Properties: &armstorage.LocalUserProperties{
			HasSSHPassword: to.Ptr(true),
			HomeDirectory:  to.Ptr("homedirectory"),
			PermissionScopes: []*armstorage.PermissionScope{
				{
					Permissions:  to.Ptr("rwd"),
					ResourceName: to.Ptr("share1"),
					Service:      to.Ptr("file"),
				},
				{
					Permissions:  to.Ptr("rw"),
					ResourceName: to.Ptr("share2"),
					Service:      to.Ptr("file"),
				}},
			SSHAuthorizedKeys: []*armstorage.SSHPublicKey{
				{
					Description: to.Ptr("key name"),
					Key:         to.Ptr("ssh-rsa keykeykeykeykey="),
				}},
		},
	}, 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.LocalUser = armstorage.LocalUser{
	// 	Name: to.Ptr("user1"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/localUsers"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1"),
	// 	Properties: &armstorage.LocalUserProperties{
	// 		HomeDirectory: to.Ptr("homedirectory"),
	// 		PermissionScopes: []*armstorage.PermissionScope{
	// 			{
	// 				Permissions: to.Ptr("rwd"),
	// 				ResourceName: to.Ptr("share1"),
	// 				Service: to.Ptr("file"),
	// 			},
	// 			{
	// 				Permissions: to.Ptr("rw"),
	// 				ResourceName: to.Ptr("share2"),
	// 				Service: to.Ptr("file"),
	// 		}},
	// 		Sid: to.Ptr("S-1-2-0-125132-153423-36235-1000"),
	// 		SSHAuthorizedKeys: []*armstorage.SSHPublicKey{
	// 			{
	// 				Description: to.Ptr("key name"),
	// 				Key: to.Ptr("ssh-rsa keykeykeykeykey="),
	// 		}},
	// 	},
	// }
}

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

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update the properties of a local user associated with the storage account
 *
 * @summary Create or update the properties of a local user associated with the storage account
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserCreate.json
 */
async function createLocalUser() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6977";
  const accountName = "sto2527";
  const username = "user1";
  const properties = {
    hasSshPassword: true,
    homeDirectory: "homedirectory",
    permissionScopes: [
      { permissions: "rwd", resourceName: "share1", service: "file" },
      { permissions: "rw", resourceName: "share2", service: "file" },
    ],
    sshAuthorizedKeys: [{ description: "key name", key: "ssh-rsa keykeykeykeykey=" }],
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.localUsersOperations.createOrUpdate(
    resourceGroupName,
    accountName,
    username,
    properties
  );
  console.log(result);
}

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
  "name": "user1",
  "type": "Microsoft.Storage/storageAccounts/localUsers",
  "properties": {
    "permissionScopes": [
      {
        "permissions": "rwd",
        "service": "file",
        "resourceName": "share1"
      },
      {
        "permissions": "rw",
        "service": "file",
        "resourceName": "share2"
      }
    ],
    "homeDirectory": "homedirectory",
    "sshAuthorizedKeys": [
      {
        "description": "key name",
        "key": "ssh-rsa keykeykeykeykey="
      }
    ],
    "sid": "S-1-2-0-125132-153423-36235-1000"
  }
}

UpdateLocalUser

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/localUsers/user1?api-version=2023-01-01

{
  "properties": {
    "homeDirectory": "homedirectory2",
    "hasSharedKey": false,
    "hasSshPassword": false,
    "hasSshKey": false
  }
}


import com.azure.resourcemanager.storage.fluent.models.LocalUserInner;

/** Samples for LocalUsersOperation CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserUpdate.json
     */
    /**
     * Sample code: UpdateLocalUser.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateLocalUser(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getLocalUsersOperations().createOrUpdateWithResponse(
            "res6977", "sto2527", "user1", new LocalUserInner().withHomeDirectory("homedirectory2")
                .withHasSharedKey(false).withHasSshKey(false).withHasSshPassword(false),
            com.azure.core.util.Context.NONE);
    }
}

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.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python local_user_update.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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.local_users.create_or_update(
        resource_group_name="res6977",
        account_name="sto2527",
        username="user1",
        properties={
            "properties": {
                "hasSharedKey": False,
                "hasSshKey": False,
                "hasSshPassword": False,
                "homeDirectory": "homedirectory2",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserUpdate.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 armstorage_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/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserUpdate.json
func ExampleLocalUsersClient_CreateOrUpdate_updateLocalUser() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLocalUsersClient().CreateOrUpdate(ctx, "res6977", "sto2527", "user1", armstorage.LocalUser{
		Properties: &armstorage.LocalUserProperties{
			HasSharedKey:   to.Ptr(false),
			HasSSHKey:      to.Ptr(false),
			HasSSHPassword: to.Ptr(false),
			HomeDirectory:  to.Ptr("homedirectory2"),
		},
	}, 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.LocalUser = armstorage.LocalUser{
	// 	Name: to.Ptr("user1"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/localUsers"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1"),
	// 	Properties: &armstorage.LocalUserProperties{
	// 		HasSharedKey: to.Ptr(false),
	// 		HasSSHKey: to.Ptr(false),
	// 		HasSSHPassword: to.Ptr(false),
	// 		HomeDirectory: to.Ptr("homedirectory2"),
	// 		Sid: to.Ptr("S-1-2-0-3528686663-1788730862-2791910117-1000"),
	// 	},
	// }
}

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

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update the properties of a local user associated with the storage account
 *
 * @summary Create or update the properties of a local user associated with the storage account
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/LocalUserUpdate.json
 */
async function updateLocalUser() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res6977";
  const accountName = "sto2527";
  const username = "user1";
  const properties = {
    hasSharedKey: false,
    hasSshKey: false,
    hasSshPassword: false,
    homeDirectory: "homedirectory2",
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.localUsersOperations.createOrUpdate(
    resourceGroupName,
    accountName,
    username,
    properties
  );
  console.log(result);
}

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/loalUsers/user1",
  "name": "user1",
  "type": "Microsoft.Storage/storageAccounts/localUsers",
  "properties": {
    "homeDirectory": "homedirectory2",
    "sid": "S-1-2-0-3528686663-1788730862-2791910117-1000",
    "hasSharedKey": false,
    "hasSshPassword": false,
    "hasSshKey": false
  }
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorResponse	Depolama kaynağı sağlayıcısından bir hata yanıtı.
ErrorResponseBody	Hata yanıtı gövde sözleşmesi.
LocalUser	Depolama hesaplarıyla ilişkili yerel kullanıcı.
PermissionScope
SshPublicKey
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Depolama kaynağı sağlayıcısından bir hata yanıtı.

Name	Tür	Description
error	ErrorResponseBody	Azure Depolama Kaynak Sağlayıcısı hata yanıtı gövdesi.

ErrorResponseBody

Hata yanıtı gövde sözleşmesi.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.

LocalUser

Depolama hesaplarıyla ilişkili yerel kullanıcı.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.hasSharedKey	boolean	Paylaşılan anahtarın mevcut olup olmadığını gösterir. Mevcut paylaşılan anahtarı kaldırmak için false olarak ayarlayın.
properties.hasSshKey	boolean	SSH anahtarının mevcut olup olmadığını gösterir. Mevcut SSH anahtarını kaldırmak için false olarak ayarlayın.
properties.hasSshPassword	boolean	SSH parolasının mevcut olup olmadığını gösterir. Mevcut SSH parolasını kaldırmak için false olarak ayarlayın.
properties.homeDirectory	string	İsteğe bağlı, yerel kullanıcı giriş dizini.
properties.permissionScopes	PermissionScope[]	Yerel kullanıcının izin kapsamları.
properties.sid	string	Sunucu tarafından oluşturulan benzersiz bir Güvenlik Tanımlayıcısı.
properties.sshAuthorizedKeys	SshPublicKey[]	İsteğe bağlı, SFTP için yerel kullanıcı ssh yetkili anahtarları.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

PermissionScope

Name	Tür	Description
permissions	string	Yerel kullanıcının izinleri. Olası değerler şunlardır: Okuma (r), Yazma (w), Silme (d), Liste (l) ve Oluştur (c).
resourceName	string	Kaynağın adı, normalde kapsayıcı adı veya yerel kullanıcı tarafından kullanılan dosya paylaşımı adı.
service	string	Yerel kullanıcı tarafından kullanılan hizmet, örneğin blob, dosya.

SshPublicKey

Name	Tür	Description
description	string	İsteğe bağlı. Anahtarın işlevini/kullanımını depolamak için kullanılır
key	string	Ssh ortak anahtarı base64 kodlanmış. Biçim şu şekilde olmalıdır: ' ', örneğin ssh-rsa AAAABBBB

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

Aracılığıyla paylaş

Local Users - Create Or Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

CreateLocalUser

Sample Request

Sample Response

UpdateLocalUser

Sample Request

Sample Response

Tanımlar

createdByType

ErrorResponse

ErrorResponseBody

LocalUser

PermissionScope

SshPublicKey

systemData

Ek kaynaklar