StorageSchemaGet

Object

Kind

string Optional
The kind of record.

Metadata

object BlobStorageMetadataSchema Required
Metadata about the storage instance.

Properties

• created
  string Optional format: date-time
  The time when the resource was created

• createdBy
  string Optional format: uuid
  ID of the user who created the resource

• createdByEmail
  string Optional
  Email of the user who created the resource

• id
  string Required format: uuid
  The ID of the resource

• name
  string Optional
  The name of the resource

• updated
  string Optional format: date-time
  The time when the resource was last updated

• updatedBy
  string Optional format: uuid
  ID of the user who last updated the resource

• updatedByEmail
  string Optional
  Email of the user who last updated the resource

Spec

object Required
The specification of the storage instance.

Variants

Discriminated by type. Select one variant:

1. Microsoft.Storage
   object AzureStorageSpecRead
   • credential
     object AzureCredentialRead Optional
     The credential for the Azure Storage Account

• sasToken
  string Required pattern: ^\?([a-z]+=[^&]+)(&[a-z]+=[^&]+)+$
  SAS Token for Azure Storage Account, including leading ?

• signedExpiry
  string Required format: date-time
  The expiry time of the token.

• signedStart
  string or null Required format: date-time
  The start time of the token.

• description
  string or null Required
  Description of the storage.

• privateLinkServiceConnection
  object or null PrivateLinkServiceConnectionNullable Optional
  Optional settings for a Private Link. Set it to null to remove the Private Link.

• requestMessage
  string Required 0-140 characters
  A message passed to the owner of the remote resource with this connection request.

• resourceGroupName
  string Required 1-90 characters
  The name of the resource group containing the storage account.

• storageAccountName
  string Required 3-24 characters
  The name of the storage account.

• subscriptionId
  string Required format: uuid
  The ID of the Azure subscription containing the storage account.

• region
  string or null Required
  Storage region.

• type
  enum Required
  The type of storage.

• url
  string Required
  HTTP(S) URL required for access to the storage.

2. AWS.S3
   object AWSStorageSpecRead
   • bucketName
     string Required pattern: ^(?!.*..)[a-z0-9][-a-z0-9.]{1,61}[a-z0-9]$
     The name of the AWS S3 bucket.

• credential
  object AWSCredential Optional
  The credential for the AWS S3 bucket.

• description
  string or null Required
  Description of the storage.

• region
  string or null Required
  Storage region.

• type
  enum Required
  The type of storage.

• url
  string Required
  The URL of the S3 bucket.

3. Google.Storage
   object GoogleStorageSpecRead
   • bucketName
     string Required 2-256 characters
     The name of the Google Storage bucket.

• credential
  object GoogleCredential Optional
  The credential for the Google Storage bucket.

• description
  string or null Required
  Description of the storage.

• region
  string or null Required
  Storage region.

• type
  enum Required
  The type of storage.

• status
  object StorageStatusRead Optional
  Additional status information regarding the storage instance.

• activeCredentialId
  string or null Required format: uuid
  The ID of the active credential for this storage.

• privateLinkServiceConnectionStatus
  enum Optional
  The state of the Azure Private Connection, if enabled.