Updates the metadata and configuration of a domain.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: managedidentities1 --scope <scope> projects locations-global-domains-patch ...

Required Scalar Argument

• <name> (string)
  • Required. The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Domain:
  admin: string
  audit-logs-enabled: boolean
  authorized-networks: [string]
  create-time: string
  fqdn: string
  labels: { string: string }
  locations: [string]
  name: string
  reserved-ip-range: string
  state: string
  status-message: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . admin=stet
  • Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
• audit-logs-enabled=false
  • Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
• authorized-networks=duo
  • Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
  • Each invocation of this argument appends the given value to the array.
• create-time=vero
  • Output only. The time the instance was created.
• fqdn=vero
  • Output only. The fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network.
• labels=key=invidunt
  • Optional. Resource labels that can contain user-provided metadata.
  • the value will be associated with the given key
• locations=stet
  • Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
  • Each invocation of this argument appends the given value to the array.
• name=vero
  • Required. The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
• reserved-ip-range=elitr
  • Required. The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorized_networks].
• state=lorem
  • Output only. The current state of this domain.
• status-message=diam
  • Output only. Additional information about the current status of this domain, if available.
• update-time=no
  • Output only. The last update time.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include fields from Domain: * labels * locations * authorized_networks * audit_logs_enabled

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").