Navigation

  • next
  • previous |
  • CDP CLI 0.9.150 (BETA) documentation »
  • cloudprivatelinks »
  • get-private-link-status

get-private-link-status¶

subtitle

Get the status of a Private Link.

version

0.9.150

Description¶

Returns the status of a Private Link.

Synopsis¶

  get-private-link-status
--subnet-ids <value>
[--v-net-id <value>]
[--vpc-id <value>]
[--cloud-service-provider <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--subnet-ids (array)

List of subnets in the given cloud network to query PrivateLink status.

Syntax:

"string" "string" ...

--v-net-id (string)

Virtual Network Id to query the status of PrivateLink in Azure.

--vpc-id (string)

VPC ID to query the status of Private Link in AWS.

--cloud-service-provider (string)

Supported cloud providers AWS - A value indicating AWS as supported cloud provider for creating privatelinks. AZURE - A value indicating Azure as supported cloud provider for creating privatelinks.

Possible values:

  • AWS

  • AZURE

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

status -> (string)

Status of the Private Link. ENABLED - Private Link is enabled. DISABLED - Private Link is disabled. ERROR - Error while retrieving the Private Link status.

Form Factors¶

public

Table of Contents

  • get-private-link-status
    • Description
    • Synopsis
    • Options
    • Output
    • Form Factors

Previous topic

delete-private-link-endpoint

Next topic

list-private-link-endpoint-statuses

Quick search

Navigation

  • next
  • previous |
  • CDP CLI 0.9.150 (BETA) documentation »
  • cloudprivatelinks »
  • get-private-link-status
© Copyright 2025, Cloudera, Inc.. Created using Sphinx 3.5.2.