create-azure-credential¶

Description¶

Creates a new Azure credential.

Synopsis¶

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

Options¶

--credential-name (string)

The name of the credential.

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

secretKey -> (string)

The client secret key (also referred to as application password) for the registered application.

Shorthand Syntax:

authenticationType=string,applicationId=string,secretKey=string

JSON Syntax:

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

--subscription-id (string)

The Azure subscription ID. Required for secret based credentials and optional for certificate based ones.

--tenant-id (string)

The Azure AD tenant ID for the Azure subscription. Required for secret based credentials and optional for certificate based ones.

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

created -> (datetime)

Creation date

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