Identity Access Context Manager v1 API - Class ServicePerimeter (2.5.0)

public sealed class ServicePerimeter : IMessage<ServicePerimeter>, IEquatable<ServicePerimeter>, IDeepCloneable<ServicePerimeter>, IBufferMessage, IMessage

Reference documentation and code samples for the Identity Access Context Manager v1 API class ServicePerimeter.

ServicePerimeter describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the ServicePerimeter. If a request with a source within this ServicePerimeter has a target outside of the ServicePerimeter, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.

Inheritance

object > ServicePerimeter

Namespace

Google.Identity.AccessContextManager.V1

Assembly

Google.Identity.AccessContextManager.V1.dll

Constructors

ServicePerimeter()

public ServicePerimeter()

ServicePerimeter(ServicePerimeter)

public ServicePerimeter(ServicePerimeter other)
Parameter
Name Description
other ServicePerimeter

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time the ServicePerimeter was created in UTC.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

Description of the ServicePerimeter and its use. Does not affect behavior.

Property Value
Type Description
string

Name

public string Name { get; set; }

Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}

Property Value
Type Description
string

PerimeterType

public ServicePerimeter.Types.PerimeterType PerimeterType { get; set; }

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

Property Value
Type Description
ServicePerimeterTypesPerimeterType

ServicePerimeterName

public ServicePerimeterName ServicePerimeterName { get; set; }

ServicePerimeterName-typed view over the Name resource name property.

Property Value
Type Description
ServicePerimeterName

Spec

public ServicePerimeterConfig Spec { get; set; }

Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set.

Property Value
Type Description
ServicePerimeterConfig

Status

public ServicePerimeterConfig Status { get; set; }

Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

Property Value
Type Description
ServicePerimeterConfig

Title

public string Title { get; set; }

Human readable title. Must be unique within the Policy.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Time the ServicePerimeter was updated in UTC.

Property Value
Type Description
Timestamp

UseExplicitDryRunSpec

public bool UseExplicitDryRunSpec { get; set; }

Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values.

Property Value
Type Description
bool