CustomImage.yml

### YamlMime:TSType
name: CustomImage
uid: '@azure/arm-devtestlabs.CustomImage'
package: '@azure/arm-devtestlabs'
summary: A custom image.
fullName: CustomImage
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: author
    uid: '@azure/arm-devtestlabs.CustomImage.author'
    package: '@azure/arm-devtestlabs'
    summary: The author of the custom image.
    fullName: author
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'author?: string'
      return:
        description: ''
        type: string
  - name: creationDate
    uid: '@azure/arm-devtestlabs.CustomImage.creationDate'
    package: '@azure/arm-devtestlabs'
    summary: >-
      The creation date of the custom image.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: creationDate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'creationDate?: Date'
      return:
        description: ''
        type: Date
  - name: customImagePlan
    uid: '@azure/arm-devtestlabs.CustomImage.customImagePlan'
    package: '@azure/arm-devtestlabs'
    summary: Storage information about the plan related to this custom image
    fullName: customImagePlan
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customImagePlan?: CustomImagePropertiesFromPlan'
      return:
        description: ''
        type: <xref uid="@azure/arm-devtestlabs.CustomImagePropertiesFromPlan" />
  - name: dataDiskStorageInfo
    uid: '@azure/arm-devtestlabs.CustomImage.dataDiskStorageInfo'
    package: '@azure/arm-devtestlabs'
    summary: Storage information about the data disks present in the custom image
    fullName: dataDiskStorageInfo
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'dataDiskStorageInfo?: DataDiskStorageTypeInfo[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-devtestlabs.DataDiskStorageTypeInfo" />[]
  - name: description
    uid: '@azure/arm-devtestlabs.CustomImage.description'
    package: '@azure/arm-devtestlabs'
    summary: The description of the custom image.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
  - name: isPlanAuthorized
    uid: '@azure/arm-devtestlabs.CustomImage.isPlanAuthorized'
    package: '@azure/arm-devtestlabs'
    summary: >-
      Whether or not the custom images underlying offer/plan has been enabled
      for programmatic deployment
    fullName: isPlanAuthorized
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isPlanAuthorized?: boolean'
      return:
        description: ''
        type: boolean
  - name: managedImageId
    uid: '@azure/arm-devtestlabs.CustomImage.managedImageId'
    package: '@azure/arm-devtestlabs'
    summary: The Managed Image Id backing the custom image.
    fullName: managedImageId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'managedImageId?: string'
      return:
        description: ''
        type: string
  - name: managedSnapshotId
    uid: '@azure/arm-devtestlabs.CustomImage.managedSnapshotId'
    package: '@azure/arm-devtestlabs'
    summary: The Managed Snapshot Id backing the custom image.
    fullName: managedSnapshotId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'managedSnapshotId?: string'
      return:
        description: ''
        type: string
  - name: provisioningState
    uid: '@azure/arm-devtestlabs.CustomImage.provisioningState'
    package: '@azure/arm-devtestlabs'
    summary: >-
      The provisioning status of the resource.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: provisioningState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provisioningState?: string'
      return:
        description: ''
        type: string
  - name: uniqueIdentifier
    uid: '@azure/arm-devtestlabs.CustomImage.uniqueIdentifier'
    package: '@azure/arm-devtestlabs'
    summary: >-
      The unique immutable identifier of a resource (Guid).

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: uniqueIdentifier
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'uniqueIdentifier?: string'
      return:
        description: ''
        type: string
  - name: vhd
    uid: '@azure/arm-devtestlabs.CustomImage.vhd'
    package: '@azure/arm-devtestlabs'
    summary: The VHD from which the image is to be created.
    fullName: vhd
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'vhd?: CustomImagePropertiesCustom'
      return:
        description: ''
        type: <xref uid="@azure/arm-devtestlabs.CustomImagePropertiesCustom" />
  - name: vm
    uid: '@azure/arm-devtestlabs.CustomImage.vm'
    package: '@azure/arm-devtestlabs'
    summary: The virtual machine from which the image is to be created.
    fullName: vm
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'vm?: CustomImagePropertiesFromVm'
      return:
        description: ''
        type: <xref uid="@azure/arm-devtestlabs.CustomImagePropertiesFromVm" />
inheritedProperties:
  - name: id
    uid: '@azure/arm-devtestlabs.CustomImage.id'
    package: '@azure/arm-devtestlabs'
    summary: >-
      The identifier of the resource.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [Resource.id](xref:@azure/arm-devtestlabs.Resource.id)
  - name: location
    uid: '@azure/arm-devtestlabs.CustomImage.location'
    package: '@azure/arm-devtestlabs'
    summary: The location of the resource.
    fullName: location
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'location?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [Resource.location](xref:@azure/arm-devtestlabs.Resource.location)
  - name: name
    uid: '@azure/arm-devtestlabs.CustomImage.name'
    package: '@azure/arm-devtestlabs'
    summary: >-
      The name of the resource.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [Resource.name](xref:@azure/arm-devtestlabs.Resource.name)
  - name: tags
    uid: '@azure/arm-devtestlabs.CustomImage.tags'
    package: '@azure/arm-devtestlabs'
    summary: The tags of the resource.
    fullName: tags
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tags?: {[propertyName: string]: string}'
      return:
        description: ''
        type: '{[propertyName: string]: string}'
    inheritanceDescription: >-
      <b>Inherited From</b>
      [Resource.tags](xref:@azure/arm-devtestlabs.Resource.tags)
  - name: type
    uid: '@azure/arm-devtestlabs.CustomImage.type'
    package: '@azure/arm-devtestlabs'
    summary: >-
      The type of the resource.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [Resource.type](xref:@azure/arm-devtestlabs.Resource.type)
extends: <xref uid="@azure/arm-devtestlabs.Resource" />