Cloud Identity-Aware Proxy v1 API - Class IdentityAwareProxyAdminServiceClient (2.7.0)

public abstract class IdentityAwareProxyAdminServiceClient

Reference documentation and code samples for the Cloud Identity-Aware Proxy v1 API class IdentityAwareProxyAdminServiceClient.

IdentityAwareProxyAdminService client wrapper, for convenient use.

Inheritance

object > IdentityAwareProxyAdminServiceClient

Namespace

Google.Cloud.Iap.V1

Assembly

Google.Cloud.Iap.V1.dll

Remarks

APIs for Identity-Aware Proxy Admin configurations.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the IdentityAwareProxyAdminService service, which is a host of "iap.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default IdentityAwareProxyAdminService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default IdentityAwareProxyAdminService scopes are:

GrpcClient

public virtual IdentityAwareProxyAdminService.IdentityAwareProxyAdminServiceClient GrpcClient { get; }

The underlying gRPC IdentityAwareProxyAdminService client

Property Value
Type Description
IdentityAwareProxyAdminServiceIdentityAwareProxyAdminServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static IdentityAwareProxyAdminServiceClient Create()

Synchronously creates a IdentityAwareProxyAdminServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IdentityAwareProxyAdminServiceClientBuilder.

Returns
Type Description
IdentityAwareProxyAdminServiceClient

The created IdentityAwareProxyAdminServiceClient.

CreateAsync(CancellationToken)

public static Task<IdentityAwareProxyAdminServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a IdentityAwareProxyAdminServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IdentityAwareProxyAdminServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskIdentityAwareProxyAdminServiceClient

The task representing the created IdentityAwareProxyAdminServiceClient.

CreateTunnelDestGroup(CreateTunnelDestGroupRequest, CallSettings)

public virtual TunnelDestGroup CreateTunnelDestGroup(CreateTunnelDestGroupRequest request, CallSettings callSettings = null)

Creates a new TunnelDestGroup.

Parameters
Name Description
request CreateTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
CreateTunnelDestGroupRequest request = new CreateTunnelDestGroupRequest
{
    ParentAsTunnelLocationName = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    TunnelDestGroup = new TunnelDestGroup(),
    TunnelDestGroupId = "",
};
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.CreateTunnelDestGroup(request);

CreateTunnelDestGroup(TunnelLocationName, TunnelDestGroup, string, CallSettings)

public virtual TunnelDestGroup CreateTunnelDestGroup(TunnelLocationName parent, TunnelDestGroup tunnelDestGroup, string tunnelDestGroupId, CallSettings callSettings = null)

Creates a new TunnelDestGroup.

Parameters
Name Description
parent TunnelLocationName

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

tunnelDestGroup TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnelDestGroupId string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]-.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TunnelLocationName parent = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
string tunnelDestGroupId = "";
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.CreateTunnelDestGroup(parent, tunnelDestGroup, tunnelDestGroupId);

CreateTunnelDestGroup(string, TunnelDestGroup, string, CallSettings)

public virtual TunnelDestGroup CreateTunnelDestGroup(string parent, TunnelDestGroup tunnelDestGroup, string tunnelDestGroupId, CallSettings callSettings = null)

Creates a new TunnelDestGroup.

Parameters
Name Description
parent string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

tunnelDestGroup TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnelDestGroupId string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]-.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]";
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
string tunnelDestGroupId = "";
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.CreateTunnelDestGroup(parent, tunnelDestGroup, tunnelDestGroupId);

CreateTunnelDestGroupAsync(CreateTunnelDestGroupRequest, CallSettings)

public virtual Task<TunnelDestGroup> CreateTunnelDestGroupAsync(CreateTunnelDestGroupRequest request, CallSettings callSettings = null)

Creates a new TunnelDestGroup.

Parameters
Name Description
request CreateTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTunnelDestGroupRequest request = new CreateTunnelDestGroupRequest
{
    ParentAsTunnelLocationName = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    TunnelDestGroup = new TunnelDestGroup(),
    TunnelDestGroupId = "",
};
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.CreateTunnelDestGroupAsync(request);

CreateTunnelDestGroupAsync(CreateTunnelDestGroupRequest, CancellationToken)

public virtual Task<TunnelDestGroup> CreateTunnelDestGroupAsync(CreateTunnelDestGroupRequest request, CancellationToken cancellationToken)

Creates a new TunnelDestGroup.

Parameters
Name Description
request CreateTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTunnelDestGroupRequest request = new CreateTunnelDestGroupRequest
{
    ParentAsTunnelLocationName = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    TunnelDestGroup = new TunnelDestGroup(),
    TunnelDestGroupId = "",
};
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.CreateTunnelDestGroupAsync(request);

CreateTunnelDestGroupAsync(TunnelLocationName, TunnelDestGroup, string, CallSettings)

public virtual Task<TunnelDestGroup> CreateTunnelDestGroupAsync(TunnelLocationName parent, TunnelDestGroup tunnelDestGroup, string tunnelDestGroupId, CallSettings callSettings = null)

Creates a new TunnelDestGroup.

Parameters
Name Description
parent TunnelLocationName

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

tunnelDestGroup TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnelDestGroupId string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]-.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelLocationName parent = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
string tunnelDestGroupId = "";
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.CreateTunnelDestGroupAsync(parent, tunnelDestGroup, tunnelDestGroupId);

CreateTunnelDestGroupAsync(TunnelLocationName, TunnelDestGroup, string, CancellationToken)

public virtual Task<TunnelDestGroup> CreateTunnelDestGroupAsync(TunnelLocationName parent, TunnelDestGroup tunnelDestGroup, string tunnelDestGroupId, CancellationToken cancellationToken)

Creates a new TunnelDestGroup.

Parameters
Name Description
parent TunnelLocationName

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

tunnelDestGroup TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnelDestGroupId string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]-.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelLocationName parent = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
string tunnelDestGroupId = "";
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.CreateTunnelDestGroupAsync(parent, tunnelDestGroup, tunnelDestGroupId);

CreateTunnelDestGroupAsync(string, TunnelDestGroup, string, CallSettings)

public virtual Task<TunnelDestGroup> CreateTunnelDestGroupAsync(string parent, TunnelDestGroup tunnelDestGroup, string tunnelDestGroupId, CallSettings callSettings = null)

Creates a new TunnelDestGroup.

Parameters
Name Description
parent string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

tunnelDestGroup TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnelDestGroupId string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]-.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]";
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
string tunnelDestGroupId = "";
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.CreateTunnelDestGroupAsync(parent, tunnelDestGroup, tunnelDestGroupId);

CreateTunnelDestGroupAsync(string, TunnelDestGroup, string, CancellationToken)

public virtual Task<TunnelDestGroup> CreateTunnelDestGroupAsync(string parent, TunnelDestGroup tunnelDestGroup, string tunnelDestGroupId, CancellationToken cancellationToken)

Creates a new TunnelDestGroup.

Parameters
Name Description
parent string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

tunnelDestGroup TunnelDestGroup

Required. The TunnelDestGroup to create.

tunnelDestGroupId string

Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name.

This value must be 4-63 characters, and valid characters are [a-z]-.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]";
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
string tunnelDestGroupId = "";
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.CreateTunnelDestGroupAsync(parent, tunnelDestGroup, tunnelDestGroupId);

DeleteTunnelDestGroup(DeleteTunnelDestGroupRequest, CallSettings)

public virtual void DeleteTunnelDestGroup(DeleteTunnelDestGroupRequest request, CallSettings callSettings = null)

Deletes a TunnelDestGroup.

Parameters
Name Description
request DeleteTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
DeleteTunnelDestGroupRequest request = new DeleteTunnelDestGroupRequest
{
    TunnelDestGroupName = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]"),
};
// Make the request
identityAwareProxyAdminServiceClient.DeleteTunnelDestGroup(request);

DeleteTunnelDestGroup(TunnelDestGroupName, CallSettings)

public virtual void DeleteTunnelDestGroup(TunnelDestGroupName name, CallSettings callSettings = null)

Deletes a TunnelDestGroup.

Parameters
Name Description
name TunnelDestGroupName

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TunnelDestGroupName name = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
// Make the request
identityAwareProxyAdminServiceClient.DeleteTunnelDestGroup(name);

DeleteTunnelDestGroup(string, CallSettings)

public virtual void DeleteTunnelDestGroup(string name, CallSettings callSettings = null)

Deletes a TunnelDestGroup.

Parameters
Name Description
name string

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]/destGroups/[DEST_GROUP]";
// Make the request
identityAwareProxyAdminServiceClient.DeleteTunnelDestGroup(name);

DeleteTunnelDestGroupAsync(DeleteTunnelDestGroupRequest, CallSettings)

public virtual Task DeleteTunnelDestGroupAsync(DeleteTunnelDestGroupRequest request, CallSettings callSettings = null)

Deletes a TunnelDestGroup.

Parameters
Name Description
request DeleteTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTunnelDestGroupRequest request = new DeleteTunnelDestGroupRequest
{
    TunnelDestGroupName = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]"),
};
// Make the request
await identityAwareProxyAdminServiceClient.DeleteTunnelDestGroupAsync(request);

DeleteTunnelDestGroupAsync(DeleteTunnelDestGroupRequest, CancellationToken)

public virtual Task DeleteTunnelDestGroupAsync(DeleteTunnelDestGroupRequest request, CancellationToken cancellationToken)

Deletes a TunnelDestGroup.

Parameters
Name Description
request DeleteTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTunnelDestGroupRequest request = new DeleteTunnelDestGroupRequest
{
    TunnelDestGroupName = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]"),
};
// Make the request
await identityAwareProxyAdminServiceClient.DeleteTunnelDestGroupAsync(request);

DeleteTunnelDestGroupAsync(TunnelDestGroupName, CallSettings)

public virtual Task DeleteTunnelDestGroupAsync(TunnelDestGroupName name, CallSettings callSettings = null)

Deletes a TunnelDestGroup.

Parameters
Name Description
name TunnelDestGroupName

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelDestGroupName name = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
// Make the request
await identityAwareProxyAdminServiceClient.DeleteTunnelDestGroupAsync(name);

DeleteTunnelDestGroupAsync(TunnelDestGroupName, CancellationToken)

public virtual Task DeleteTunnelDestGroupAsync(TunnelDestGroupName name, CancellationToken cancellationToken)

Deletes a TunnelDestGroup.

Parameters
Name Description
name TunnelDestGroupName

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelDestGroupName name = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
// Make the request
await identityAwareProxyAdminServiceClient.DeleteTunnelDestGroupAsync(name);

DeleteTunnelDestGroupAsync(string, CallSettings)

public virtual Task DeleteTunnelDestGroupAsync(string name, CallSettings callSettings = null)

Deletes a TunnelDestGroup.

Parameters
Name Description
name string

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]/destGroups/[DEST_GROUP]";
// Make the request
await identityAwareProxyAdminServiceClient.DeleteTunnelDestGroupAsync(name);

DeleteTunnelDestGroupAsync(string, CancellationToken)

public virtual Task DeleteTunnelDestGroupAsync(string name, CancellationToken cancellationToken)

Deletes a TunnelDestGroup.

Parameters
Name Description
name string

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]/destGroups/[DEST_GROUP]";
// Make the request
await identityAwareProxyAdminServiceClient.DeleteTunnelDestGroupAsync(name);

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = identityAwareProxyAdminServiceClient.GetIamPolicy(request);

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken cancellationToken)

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request GetIamPolicyRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.GetIamPolicyAsync(request);

GetIapSettings(GetIapSettingsRequest, CallSettings)

public virtual IapSettings GetIapSettings(GetIapSettingsRequest request, CallSettings callSettings = null)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name Description
request GetIapSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IapSettings

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
GetIapSettingsRequest request = new GetIapSettingsRequest { Name = "", };
// Make the request
IapSettings response = identityAwareProxyAdminServiceClient.GetIapSettings(request);

GetIapSettingsAsync(GetIapSettingsRequest, CallSettings)

public virtual Task<IapSettings> GetIapSettingsAsync(GetIapSettingsRequest request, CallSettings callSettings = null)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name Description
request GetIapSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIapSettings

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIapSettingsRequest request = new GetIapSettingsRequest { Name = "", };
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.GetIapSettingsAsync(request);

GetIapSettingsAsync(GetIapSettingsRequest, CancellationToken)

public virtual Task<IapSettings> GetIapSettingsAsync(GetIapSettingsRequest request, CancellationToken cancellationToken)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name Description
request GetIapSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIapSettings

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIapSettingsRequest request = new GetIapSettingsRequest { Name = "", };
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.GetIapSettingsAsync(request);

GetTunnelDestGroup(GetTunnelDestGroupRequest, CallSettings)

public virtual TunnelDestGroup GetTunnelDestGroup(GetTunnelDestGroupRequest request, CallSettings callSettings = null)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
request GetTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
GetTunnelDestGroupRequest request = new GetTunnelDestGroupRequest
{
    TunnelDestGroupName = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]"),
};
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.GetTunnelDestGroup(request);

GetTunnelDestGroup(TunnelDestGroupName, CallSettings)

public virtual TunnelDestGroup GetTunnelDestGroup(TunnelDestGroupName name, CallSettings callSettings = null)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
name TunnelDestGroupName

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TunnelDestGroupName name = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.GetTunnelDestGroup(name);

GetTunnelDestGroup(string, CallSettings)

public virtual TunnelDestGroup GetTunnelDestGroup(string name, CallSettings callSettings = null)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
name string

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]/destGroups/[DEST_GROUP]";
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.GetTunnelDestGroup(name);

GetTunnelDestGroupAsync(GetTunnelDestGroupRequest, CallSettings)

public virtual Task<TunnelDestGroup> GetTunnelDestGroupAsync(GetTunnelDestGroupRequest request, CallSettings callSettings = null)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
request GetTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetTunnelDestGroupRequest request = new GetTunnelDestGroupRequest
{
    TunnelDestGroupName = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]"),
};
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.GetTunnelDestGroupAsync(request);

GetTunnelDestGroupAsync(GetTunnelDestGroupRequest, CancellationToken)

public virtual Task<TunnelDestGroup> GetTunnelDestGroupAsync(GetTunnelDestGroupRequest request, CancellationToken cancellationToken)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
request GetTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetTunnelDestGroupRequest request = new GetTunnelDestGroupRequest
{
    TunnelDestGroupName = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]"),
};
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.GetTunnelDestGroupAsync(request);

GetTunnelDestGroupAsync(TunnelDestGroupName, CallSettings)

public virtual Task<TunnelDestGroup> GetTunnelDestGroupAsync(TunnelDestGroupName name, CallSettings callSettings = null)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
name TunnelDestGroupName

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelDestGroupName name = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.GetTunnelDestGroupAsync(name);

GetTunnelDestGroupAsync(TunnelDestGroupName, CancellationToken)

public virtual Task<TunnelDestGroup> GetTunnelDestGroupAsync(TunnelDestGroupName name, CancellationToken cancellationToken)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
name TunnelDestGroupName

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelDestGroupName name = TunnelDestGroupName.FromProjectLocationDestGroup("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.GetTunnelDestGroupAsync(name);

GetTunnelDestGroupAsync(string, CallSettings)

public virtual Task<TunnelDestGroup> GetTunnelDestGroupAsync(string name, CallSettings callSettings = null)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
name string

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]/destGroups/[DEST_GROUP]";
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.GetTunnelDestGroupAsync(name);

GetTunnelDestGroupAsync(string, CancellationToken)

public virtual Task<TunnelDestGroup> GetTunnelDestGroupAsync(string name, CancellationToken cancellationToken)

Retrieves an existing TunnelDestGroup.

Parameters
Name Description
name string

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]/destGroups/[DEST_GROUP]";
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.GetTunnelDestGroupAsync(name);

ListTunnelDestGroups(ListTunnelDestGroupsRequest, CallSettings)

public virtual PagedEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> ListTunnelDestGroups(ListTunnelDestGroupsRequest request, CallSettings callSettings = null)

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name Description
request ListTunnelDestGroupsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListTunnelDestGroupsResponseTunnelDestGroup

A pageable sequence of TunnelDestGroup resources.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
ListTunnelDestGroupsRequest request = new ListTunnelDestGroupsRequest
{
    ParentAsTunnelLocationName = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> response = identityAwareProxyAdminServiceClient.ListTunnelDestGroups(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TunnelDestGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTunnelDestGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TunnelDestGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TunnelDestGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TunnelDestGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTunnelDestGroups(TunnelLocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> ListTunnelDestGroups(TunnelLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name Description
parent TunnelLocationName

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}. A - can be used for the location to group across all locations.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListTunnelDestGroupsResponseTunnelDestGroup

A pageable sequence of TunnelDestGroup resources.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TunnelLocationName parent = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> response = identityAwareProxyAdminServiceClient.ListTunnelDestGroups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TunnelDestGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTunnelDestGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TunnelDestGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TunnelDestGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TunnelDestGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTunnelDestGroups(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> ListTunnelDestGroups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name Description
parent string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}. A - can be used for the location to group across all locations.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListTunnelDestGroupsResponseTunnelDestGroup

A pageable sequence of TunnelDestGroup resources.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> response = identityAwareProxyAdminServiceClient.ListTunnelDestGroups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TunnelDestGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTunnelDestGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TunnelDestGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TunnelDestGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TunnelDestGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTunnelDestGroupsAsync(ListTunnelDestGroupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> ListTunnelDestGroupsAsync(ListTunnelDestGroupsRequest request, CallSettings callSettings = null)

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name Description
request ListTunnelDestGroupsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListTunnelDestGroupsResponseTunnelDestGroup

A pageable asynchronous sequence of TunnelDestGroup resources.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
ListTunnelDestGroupsRequest request = new ListTunnelDestGroupsRequest
{
    ParentAsTunnelLocationName = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> response = identityAwareProxyAdminServiceClient.ListTunnelDestGroupsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TunnelDestGroup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTunnelDestGroupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TunnelDestGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TunnelDestGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TunnelDestGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTunnelDestGroupsAsync(TunnelLocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> ListTunnelDestGroupsAsync(TunnelLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name Description
parent TunnelLocationName

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}. A - can be used for the location to group across all locations.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListTunnelDestGroupsResponseTunnelDestGroup

A pageable asynchronous sequence of TunnelDestGroup resources.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelLocationName parent = TunnelLocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> response = identityAwareProxyAdminServiceClient.ListTunnelDestGroupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TunnelDestGroup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTunnelDestGroupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TunnelDestGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TunnelDestGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TunnelDestGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTunnelDestGroupsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> ListTunnelDestGroupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name Description
parent string

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}. A - can be used for the location to group across all locations.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListTunnelDestGroupsResponseTunnelDestGroup

A pageable asynchronous sequence of TunnelDestGroup resources.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/iap_tunnel/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListTunnelDestGroupsResponse, TunnelDestGroup> response = identityAwareProxyAdminServiceClient.ListTunnelDestGroupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TunnelDestGroup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTunnelDestGroupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TunnelDestGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TunnelDestGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TunnelDestGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = identityAwareProxyAdminServiceClient.SetIamPolicy(request);

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request SetIamPolicyRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
    UpdateMask = new FieldMask(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.SetIamPolicyAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TestIamPermissionsResponse

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = identityAwareProxyAdminServiceClient.TestIamPermissions(request);

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await identityAwareProxyAdminServiceClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken cancellationToken)

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name Description
request TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await identityAwareProxyAdminServiceClient.TestIamPermissionsAsync(request);

UpdateIapSettings(UpdateIapSettingsRequest, CallSettings)

public virtual IapSettings UpdateIapSettings(UpdateIapSettingsRequest request, CallSettings callSettings = null)

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name Description
request UpdateIapSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IapSettings

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
UpdateIapSettingsRequest request = new UpdateIapSettingsRequest
{
    IapSettings = new IapSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
IapSettings response = identityAwareProxyAdminServiceClient.UpdateIapSettings(request);

UpdateIapSettingsAsync(UpdateIapSettingsRequest, CallSettings)

public virtual Task<IapSettings> UpdateIapSettingsAsync(UpdateIapSettingsRequest request, CallSettings callSettings = null)

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name Description
request UpdateIapSettingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIapSettings

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateIapSettingsRequest request = new UpdateIapSettingsRequest
{
    IapSettings = new IapSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.UpdateIapSettingsAsync(request);

UpdateIapSettingsAsync(UpdateIapSettingsRequest, CancellationToken)

public virtual Task<IapSettings> UpdateIapSettingsAsync(UpdateIapSettingsRequest request, CancellationToken cancellationToken)

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name Description
request UpdateIapSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIapSettings

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateIapSettingsRequest request = new UpdateIapSettingsRequest
{
    IapSettings = new IapSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.UpdateIapSettingsAsync(request);

UpdateTunnelDestGroup(TunnelDestGroup, FieldMask, CallSettings)

public virtual TunnelDestGroup UpdateTunnelDestGroup(TunnelDestGroup tunnelDestGroup, FieldMask updateMask, CallSettings callSettings = null)

Updates a TunnelDestGroup.

Parameters
Name Description
tunnelDestGroup TunnelDestGroup

Required. The new values for the TunnelDestGroup.

updateMask FieldMask

A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
FieldMask updateMask = new FieldMask();
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.UpdateTunnelDestGroup(tunnelDestGroup, updateMask);

UpdateTunnelDestGroup(UpdateTunnelDestGroupRequest, CallSettings)

public virtual TunnelDestGroup UpdateTunnelDestGroup(UpdateTunnelDestGroupRequest request, CallSettings callSettings = null)

Updates a TunnelDestGroup.

Parameters
Name Description
request UpdateTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TunnelDestGroup

The RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
UpdateTunnelDestGroupRequest request = new UpdateTunnelDestGroupRequest
{
    TunnelDestGroup = new TunnelDestGroup(),
    UpdateMask = new FieldMask(),
};
// Make the request
TunnelDestGroup response = identityAwareProxyAdminServiceClient.UpdateTunnelDestGroup(request);

UpdateTunnelDestGroupAsync(TunnelDestGroup, FieldMask, CallSettings)

public virtual Task<TunnelDestGroup> UpdateTunnelDestGroupAsync(TunnelDestGroup tunnelDestGroup, FieldMask updateMask, CallSettings callSettings = null)

Updates a TunnelDestGroup.

Parameters
Name Description
tunnelDestGroup TunnelDestGroup

Required. The new values for the TunnelDestGroup.

updateMask FieldMask

A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
FieldMask updateMask = new FieldMask();
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.UpdateTunnelDestGroupAsync(tunnelDestGroup, updateMask);

UpdateTunnelDestGroupAsync(TunnelDestGroup, FieldMask, CancellationToken)

public virtual Task<TunnelDestGroup> UpdateTunnelDestGroupAsync(TunnelDestGroup tunnelDestGroup, FieldMask updateMask, CancellationToken cancellationToken)

Updates a TunnelDestGroup.

Parameters
Name Description
tunnelDestGroup TunnelDestGroup

Required. The new values for the TunnelDestGroup.

updateMask FieldMask

A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TunnelDestGroup tunnelDestGroup = new TunnelDestGroup();
FieldMask updateMask = new FieldMask();
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.UpdateTunnelDestGroupAsync(tunnelDestGroup, updateMask);

UpdateTunnelDestGroupAsync(UpdateTunnelDestGroupRequest, CallSettings)

public virtual Task<TunnelDestGroup> UpdateTunnelDestGroupAsync(UpdateTunnelDestGroupRequest request, CallSettings callSettings = null)

Updates a TunnelDestGroup.

Parameters
Name Description
request UpdateTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTunnelDestGroupRequest request = new UpdateTunnelDestGroupRequest
{
    TunnelDestGroup = new TunnelDestGroup(),
    UpdateMask = new FieldMask(),
};
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.UpdateTunnelDestGroupAsync(request);

UpdateTunnelDestGroupAsync(UpdateTunnelDestGroupRequest, CancellationToken)

public virtual Task<TunnelDestGroup> UpdateTunnelDestGroupAsync(UpdateTunnelDestGroupRequest request, CancellationToken cancellationToken)

Updates a TunnelDestGroup.

Parameters
Name Description
request UpdateTunnelDestGroupRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskTunnelDestGroup

A Task containing the RPC response.

Example
// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTunnelDestGroupRequest request = new UpdateTunnelDestGroupRequest
{
    TunnelDestGroup = new TunnelDestGroup(),
    UpdateMask = new FieldMask(),
};
// Make the request
TunnelDestGroup response = await identityAwareProxyAdminServiceClient.UpdateTunnelDestGroupAsync(request);