cloudcredential

Contents

• Services

  • CloudCredentialService

• Messages

  • AzureCredentials
  • CloudCredential
  • Config
  • CreateCloudCredentialRequest
  • DeleteCloudCredentialRequest
  • GetCloudCredentialRequest
  • GoogleCredentials
  • ListCloudCredentialsRequest
  • ListCloudCredentialsResponse
  • Provider
  • S3Credentials
  • UnstructuredCredentials
  • UnstructuredCredentials.CredentialDataEntry
  • UpdateCloudCredentialRequest

• Scalar Value Types

CloudCredentialService

CloudCredentialService serves and manages cloud credentials.

GetCloudCredential

rpc GetCloudCredential(GetCloudCredentialRequest) CloudCredential

Get API returns the cloud credential details sans the actual credentials.

CreateCloudCredential

rpc CreateCloudCredential(CreateCloudCredentialRequest) CloudCredential

Create API creates a set of cloud credentials for a Tenant (Organization).

UpdateCloudCredential

rpc UpdateCloudCredential(UpdateCloudCredentialRequest) CloudCredential

Update API updates a cloud credential.

ListCloudCredentials

rpc ListCloudCredentials(ListCloudCredentialsRequest) ListCloudCredentialsResponse

(-- api-linter: core::0132::http-body=disabled api-linter: core::0132::http-method=disabled aip.dev/not-precedent: We need to do this because we can't have advance filters as query params. --) List API lists all the cloud credentials for a Tenant (Organization).

DeleteCloudCredential

rpc DeleteCloudCredential(DeleteCloudCredentialRequest) .google.protobuf.Empty

Delete API deletes the cloud credentials.

Messages

AzureCredentials

Azure Credentials.

Field	Type	Description
storage_account_name	string	Name of account.
storage_account_key	string	Key used to connect.

CloudCredential

Resource representing a Cloud Credential.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the resource.
config	Config	Desired configuration of the Cloud Credential.

Config

Desired configuration of the Cloud Credential.

Field	Type	Description
provider	Provider	Type of cloud credential.
oneof Credentials.azure_credentials	AzureCredentials	Azure Credentials.
oneof Credentials.google_credentials	GoogleCredentials	Google Credentials.
oneof Credentials.s3_credentials	S3Credentials	S3 or S3 compatible credentials.
oneof Credentials.unstructured_credentials	UnstructuredCredentials	Untructured credentials.

CreateCloudCredentialRequest

Request to create a cloud credential.

Field	Type	Description
tenant_id	string	The parent Tenant (Organization) id under which cloud credential will be created. (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to support creation of the resource in the Tenant (Organization) context. --)
cloud_credential	CloudCredential	Cloud credential configuration.

DeleteCloudCredentialRequest

Request to delete a cloud credential.

Field	Type	Description
id	string	ID of the cloud credential.

GetCloudCredentialRequest

Request to get a cloud credential.

Field	Type	Description
id	string	ID of the cloud credential.
include_config	bool	Specifies option to include configuration details excluding sensitive information.

GoogleCredentials

Google Credentials.

Field	Type	Description
project_id	string	Project ID.
json_key	string	JSON Key used to connect.

ListCloudCredentialsRequest

Request to list the cloud credentials for a Tenant (Organization) or a project.

Field	Type	Description
tenant_id	string	Tenant (Organization) ID for which the credentials will be listed.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination metadata for this response.
label_selector	public.portworx.common.v1.Selector	Provides the key in labels and associated values for which cloud credentials need to be listed.
field_selector	public.portworx.common.v1.Selector	Field selector is used to filter cloud credentials based on the fields in the cloud credential's proto message.
infra_resource_selector	public.portworx.common.v1.ResourceSelector	Infra_resource_selector is used to filter cloud credentials based on the infra resources associated with the cloud credentials. Supported infra resource filters: PROJECT.
resp_data	public.portworx.common.v1.RespData	Response data flags for listing cloud credentials.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of cloud credentials to be sorted.

ListCloudCredentialsResponse

Response of list cloud credentials.

Field	Type	Description
cloud_credentials	repeated CloudCredential	The list of cloud credentials scoped to a Tenant (Organization) or a project.
pagination	public.portworx.common.v1.PageBasedPaginationResponse	Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --)

Provider

Provider associated with created credentials.

Field	Type	Description
cloud_provider	Provider.Type	Type of cloud credential.

S3Credentials

S3 or S3 compatible credentials.

Field	Type	Description
access_key	string	Access key used to connect.
secret_key	string	Secret key used to connect.

UnstructuredCredentials

Unstructured Credentials.

Field	Type	Description
credential_data	map UnstructuredCredentials.CredentialDataEntry	Credentials in key value format.

UnstructuredCredentials.CredentialDataEntry

Field	Type	Description
key	string	none
value	string	none

UpdateCloudCredentialRequest

Request to update a cloud credential.

Field	Type	Description
update_mask	google.protobuf.FieldMask	Specifies the field that should be updated to the value specified in cloud_credentials.
id	string	ID of the cloud credential to be updated.
cloud_credential	CloudCredential	Desired cloud credential configuration.

Enums

Provider.Type

Type of provider.

Name	Number	Description
TYPE_UNSPECIFIED	0	Type unspecified.
AZURE	1	Azure Cloud.
GOOGLE	2	Google Cloud.
S3COMPATIBLE	3	S3 Compatible.
UNSTRUCTURED	4	Unstructured credentials.

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str