update-azure-credential

subtitle

Updates a new certificate based Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.

version

0.9.109

Description

Updates a certificate based Azure credential.

Synopsis

  update-azure-credential
--credential-name <value>
--subscription-id <value>
--tenant-id <value>
--app-based <value>
[--description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--credential-name (string)

The name of the credential.

--subscription-id (string)

The Azure subscription ID.

--tenant-id (string)

The Azure AD tenant ID for the Azure subscription.

--app-based (object)

Additional configurations needed for app-based authentication.

authenticationType -> (string)

Authentication type of the credential

applicationId -> (string)

The id of the application registered in Azure.

Shorthand Syntax:

authenticationType=string,applicationId=string

JSON Syntax:

{
  "authenticationType": "CERTIFICATE"|"SECRET",
  "applicationId": "string"
}

--description (string)

A description for the credential.

--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

credential -> (object)

A credential object.

credentialName -> (string)

The name of the credential.

crn -> (string)

The CRN of the credential.

cloudPlatform -> (string)

The cloud provider.

description -> (string)

A description for the credential.

awsCredentialProperties -> (object)

The credential properties that closely related to those that have been created on AWS.

roleArn -> (string)

The AWS role arn for the given credential.

govCloud -> (boolean)

Flag that indicates that the given AWS credential is GovCloud specfic.

azureCredentialProperties -> (object)

The credential properties that closely related to those that have been created on Azure.

subscriptionId -> (string)

The Azure subscription ID for the given credential.

tenantId -> (string)

The Azure tenant ID for the given credential.

appId -> (string)

The ID of the created Azure app.

authenticationType -> (string)

Authentication type of the credential

certificate -> (object)

The certificate used for the credential

status -> (string)

The status of an Azure credential.

expiration -> (string)

the expiration timestamp

expirationDate -> (datetime)

the expiration in date format

sha512 -> (string)

The SHA512 digest of the certificate

base64 -> (string)

The certificate (PEM) encoded in base64 format

gcpCredentialProperties -> (object)

The credential properties that closely related to those that have created on GCP.

keyType -> (string)

The GCP credential key type. Json is the only supported key type.

Form Factors

public, private