GoogleApi.CloudKMS.V1.Api.Projects.cloudkms_projects_locations_key_rings_crypto_keys_create

You're seeing just the function cloudkms_projects_locations_key_rings_crypto_keys_create, go back to GoogleApi.CloudKMS.V1.Api.Projects module for more information.
Link to this function

cloudkms_projects_locations_key_rings_crypto_keys_create(connection, projects_id, locations_id, key_rings_id, optional_params \\ [], opts \\ [])

View Source

Specs

cloudkms_projects_locations_key_rings_crypto_keys_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

Parameters

  • connection (type: GoogleApi.CloudKMS.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The name of the KeyRing associated with the CryptoKeys.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • key_rings_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :cryptoKeyId (type: String.t) - Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}
    • :skipInitialVersionCreation (type: boolean()) - If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.
    • :body (type: GoogleApi.CloudKMS.V1.Model.CryptoKey.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success
  • {:error, info} on failure