gcloud_alpha_pubsub_subscriptions_set-iam-policy (1)
NAME
- gcloud alpha pubsub subscriptions set-iam-policy - set the IAM policy for a Cloud Pub/Sub Subscription
SYNOPSIS
-
gcloud alpha pubsub subscriptions set-iam-policy SUBSCRIPTION POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) This command replaces the existing IAM policy for a subscription,
If the given policy file specifies an "etag" value, then the replacement will succeed only if the policy already in place matches that etag. (An etag obtained via get-iam-policy will prevent the replacement if the policy for the subscription has been subsequently updated.) A policy file that does not contain an etag value will replace any existing policy for the subscription.
POSITIONAL ARGUMENTS
-
-
Subscription resource - The subscription for which to set the IAM policy. This
represents a Cloud resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways. To set the [project] attribute: provide
the argument [subscription] on the command line with a fully specified name;
provide the argument [--project] on the command line; set the property
[core/project]. This must be specified.
-
- SUBSCRIPTION
-
ID of the subscription or fully qualified identifier for the subscription.
-
- POLICY_FILE
-
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any JSON or YAML file conforming to the structure of a Policy (cloud.google.com/iam/reference/rest/v1/Policy
-
Subscription resource - The subscription for which to set the IAM policy. This
represents a Cloud resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways. To set the [project] attribute: provide
the argument [subscription] on the command line with a fully specified name;
provide the argument [--project] on the command line; set the property
[core/project]. This must be specified.
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
API REFERENCE
This command uses the pubsub/v1 API. The full documentation for this API can be found at: cloud.google.com/pubsub/docs
EXAMPLES
The following command will read an IAM policy defined in a JSON file policy.json and set it for a subscription my-sub
- $ gcloud alpha pubsub subscriptions set-iam-policy my-sub policy.json
- See cloud.google.com/iam/docs/managing-policies for details of the policy file format and contents.
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support This variant is also available:
- $ gcloud beta pubsub subscriptions set-iam-policy