Update
Updates the specified service account.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const ServiceAccount = cloudApi.iam.service_account.ServiceAccount;
const UpdateServiceAccountRequest =
cloudApi.iam.service_account_service.UpdateServiceAccountRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.ServiceAccountServiceClient);
const operation = await client.update(
UpdateServiceAccountRequest.fromPartial({
serviceAccountId: "serviceAccountId",
// updateMask: {
// paths: ["paths"]
// },
name: "name",
// description: "description",
// labels: {"key": "labels"}
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof ServiceAccount>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.iam.v1.service_account_pb2 import ServiceAccount
from yandex.cloud.iam.v1.service_account_service_pb2_grpc import ServiceAccountServiceStub
from yandex.cloud.iam.v1.service_account_service_pb2 import UpdateServiceAccountMetadata
from yandex.cloud.iam.v1.service_account_service_pb2 import UpdateServiceAccountRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(ServiceAccountServiceStub)
operation = service.Update(
UpdateServiceAccountRequest(
service_account_id="serviceAccountId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
name="name",
# description = "description",
# labels = {"key": "labels"}
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=ServiceAccount,
meta_type=UpdateServiceAccountMetadata,
)
print(operation_result)
UpdateServiceAccountRequest
serviceAccountId
: string
ID of the ServiceAccount resource to update. To get the service account ID, use a ServiceAccountService.List request.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which fields of the ServiceAccount resource are going to be updated.
name
: string
Name of the service account. The name must be unique within the cloud.
description
: string
Description of the service account.
labels
: string
Resource labels as key:value
pairs.
Operation
An Operation resource. For more information, see Operation.
id
: string
ID of the operation.
description
: string
Description of the operation. 0-256 characters long.
createdAt
: google.protobuf.Timestamp
Creation timestamp.
createdBy
: string
ID of the user or service account who initiated the operation.
modifiedAt
: google.protobuf.Timestamp
The time when the Operation resource was last modified.
done
: bool
If the value is false
, it means the operation is still in progress.
If true
, the operation is completed, and either error
or response
is available.
metadata
: google.protobuf.Any
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
One of result
The operation result.
If done == false
and there was no failure detected, neither error
nor response
is set.
If done == false
and there was a failure detected, error
is set.
If done == true
, exactly one of error
or response
is set.
error
: google.rpc.StatusThe error result of the operation in case of failure or cancellation.
response
: google.protobuf.AnyThe normal response of the operation in case of success.
If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.