1. Packages
  2. Azure Native
  3. API Docs
  4. devcenter
  5. getDevBoxDefinition
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.devcenter.getDevBoxDefinition

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    Gets a Dev Box definition API Version: 2022-09-01-preview.

    Using getDevBoxDefinition

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDevBoxDefinition(args: GetDevBoxDefinitionArgs, opts?: InvokeOptions): Promise<GetDevBoxDefinitionResult>
    function getDevBoxDefinitionOutput(args: GetDevBoxDefinitionOutputArgs, opts?: InvokeOptions): Output<GetDevBoxDefinitionResult>
    def get_dev_box_definition(dev_box_definition_name: Optional[str] = None,
                               dev_center_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetDevBoxDefinitionResult
    def get_dev_box_definition_output(dev_box_definition_name: Optional[pulumi.Input[str]] = None,
                               dev_center_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetDevBoxDefinitionResult]
    func LookupDevBoxDefinition(ctx *Context, args *LookupDevBoxDefinitionArgs, opts ...InvokeOption) (*LookupDevBoxDefinitionResult, error)
    func LookupDevBoxDefinitionOutput(ctx *Context, args *LookupDevBoxDefinitionOutputArgs, opts ...InvokeOption) LookupDevBoxDefinitionResultOutput

    > Note: This function is named LookupDevBoxDefinition in the Go SDK.

    public static class GetDevBoxDefinition 
    {
        public static Task<GetDevBoxDefinitionResult> InvokeAsync(GetDevBoxDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetDevBoxDefinitionResult> Invoke(GetDevBoxDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDevBoxDefinitionResult> getDevBoxDefinition(GetDevBoxDefinitionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:devcenter:getDevBoxDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DevBoxDefinitionName string

    The name of the Dev Box definition.

    DevCenterName string

    The name of the devcenter.

    ResourceGroupName string

    Name of the resource group within the Azure subscription.

    DevBoxDefinitionName string

    The name of the Dev Box definition.

    DevCenterName string

    The name of the devcenter.

    ResourceGroupName string

    Name of the resource group within the Azure subscription.

    devBoxDefinitionName String

    The name of the Dev Box definition.

    devCenterName String

    The name of the devcenter.

    resourceGroupName String

    Name of the resource group within the Azure subscription.

    devBoxDefinitionName string

    The name of the Dev Box definition.

    devCenterName string

    The name of the devcenter.

    resourceGroupName string

    Name of the resource group within the Azure subscription.

    dev_box_definition_name str

    The name of the Dev Box definition.

    dev_center_name str

    The name of the devcenter.

    resource_group_name str

    Name of the resource group within the Azure subscription.

    devBoxDefinitionName String

    The name of the Dev Box definition.

    devCenterName String

    The name of the devcenter.

    resourceGroupName String

    Name of the resource group within the Azure subscription.

    getDevBoxDefinition Result

    The following output properties are available:

    ActiveImageReference Pulumi.AzureNative.DevCenter.Outputs.ImageReferenceResponse

    Image reference information for the currently active image (only populated during updates).

    Id string

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    ImageReference Pulumi.AzureNative.DevCenter.Outputs.ImageReferenceResponse

    Image reference information.

    ImageValidationErrorDetails Pulumi.AzureNative.DevCenter.Outputs.ImageValidationErrorDetailsResponse

    Details for image validator error. Populated when the image validation is not successful.

    ImageValidationStatus string

    Validation status of the configured image.

    Location string

    The geo-location where the resource lives

    Name string

    The name of the resource

    OsStorageType string

    The storage type used for the Operating System disk of Dev Boxes created using this definition.

    ProvisioningState string

    The provisioning state of the resource.

    Sku Pulumi.AzureNative.DevCenter.Outputs.SkuResponse

    The SKU for Dev Boxes created using this definition.

    SystemData Pulumi.AzureNative.DevCenter.Outputs.SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Tags Dictionary<string, string>

    Resource tags.

    ActiveImageReference ImageReferenceResponse

    Image reference information for the currently active image (only populated during updates).

    Id string

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    ImageReference ImageReferenceResponse

    Image reference information.

    ImageValidationErrorDetails ImageValidationErrorDetailsResponse

    Details for image validator error. Populated when the image validation is not successful.

    ImageValidationStatus string

    Validation status of the configured image.

    Location string

    The geo-location where the resource lives

    Name string

    The name of the resource

    OsStorageType string

    The storage type used for the Operating System disk of Dev Boxes created using this definition.

    ProvisioningState string

    The provisioning state of the resource.

    Sku SkuResponse

    The SKU for Dev Boxes created using this definition.

    SystemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Tags map[string]string

    Resource tags.

    activeImageReference ImageReferenceResponse

    Image reference information for the currently active image (only populated during updates).

    id String

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    imageReference ImageReferenceResponse

    Image reference information.

    imageValidationErrorDetails ImageValidationErrorDetailsResponse

    Details for image validator error. Populated when the image validation is not successful.

    imageValidationStatus String

    Validation status of the configured image.

    location String

    The geo-location where the resource lives

    name String

    The name of the resource

    osStorageType String

    The storage type used for the Operating System disk of Dev Boxes created using this definition.

    provisioningState String

    The provisioning state of the resource.

    sku SkuResponse

    The SKU for Dev Boxes created using this definition.

    systemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    tags Map<String,String>

    Resource tags.

    activeImageReference ImageReferenceResponse

    Image reference information for the currently active image (only populated during updates).

    id string

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    imageReference ImageReferenceResponse

    Image reference information.

    imageValidationErrorDetails ImageValidationErrorDetailsResponse

    Details for image validator error. Populated when the image validation is not successful.

    imageValidationStatus string

    Validation status of the configured image.

    location string

    The geo-location where the resource lives

    name string

    The name of the resource

    osStorageType string

    The storage type used for the Operating System disk of Dev Boxes created using this definition.

    provisioningState string

    The provisioning state of the resource.

    sku SkuResponse

    The SKU for Dev Boxes created using this definition.

    systemData SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    tags {[key: string]: string}

    Resource tags.

    active_image_reference ImageReferenceResponse

    Image reference information for the currently active image (only populated during updates).

    id str

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    image_reference ImageReferenceResponse

    Image reference information.

    image_validation_error_details ImageValidationErrorDetailsResponse

    Details for image validator error. Populated when the image validation is not successful.

    image_validation_status str

    Validation status of the configured image.

    location str

    The geo-location where the resource lives

    name str

    The name of the resource

    os_storage_type str

    The storage type used for the Operating System disk of Dev Boxes created using this definition.

    provisioning_state str

    The provisioning state of the resource.

    sku SkuResponse

    The SKU for Dev Boxes created using this definition.

    system_data SystemDataResponse

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type str

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    tags Mapping[str, str]

    Resource tags.

    activeImageReference Property Map

    Image reference information for the currently active image (only populated during updates).

    id String

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    imageReference Property Map

    Image reference information.

    imageValidationErrorDetails Property Map

    Details for image validator error. Populated when the image validation is not successful.

    imageValidationStatus String

    Validation status of the configured image.

    location String

    The geo-location where the resource lives

    name String

    The name of the resource

    osStorageType String

    The storage type used for the Operating System disk of Dev Boxes created using this definition.

    provisioningState String

    The provisioning state of the resource.

    sku Property Map

    The SKU for Dev Boxes created using this definition.

    systemData Property Map

    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    tags Map<String>

    Resource tags.

    Supporting Types

    ImageReferenceResponse

    ExactVersion string

    The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

    Id string

    Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

    Offer string

    The image offer.

    Publisher string

    The image publisher.

    Sku string

    The image sku.

    ExactVersion string

    The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

    Id string

    Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

    Offer string

    The image offer.

    Publisher string

    The image publisher.

    Sku string

    The image sku.

    exactVersion String

    The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

    id String

    Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

    offer String

    The image offer.

    publisher String

    The image publisher.

    sku String

    The image sku.

    exactVersion string

    The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

    id string

    Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

    offer string

    The image offer.

    publisher string

    The image publisher.

    sku string

    The image sku.

    exact_version str

    The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

    id str

    Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

    offer str

    The image offer.

    publisher str

    The image publisher.

    sku str

    The image sku.

    exactVersion String

    The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.

    id String

    Image ID, or Image version ID. When Image ID is provided, its latest version will be used.

    offer String

    The image offer.

    publisher String

    The image publisher.

    sku String

    The image sku.

    ImageValidationErrorDetailsResponse

    Code string

    An identifier for the error.

    Message string

    A message describing the error.

    Code string

    An identifier for the error.

    Message string

    A message describing the error.

    code String

    An identifier for the error.

    message String

    A message describing the error.

    code string

    An identifier for the error.

    message string

    A message describing the error.

    code str

    An identifier for the error.

    message str

    A message describing the error.

    code String

    An identifier for the error.

    message String

    A message describing the error.

    SkuResponse

    Name string

    The name of the SKU. Ex - P3. It is typically a letter+number code

    Capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    Family string

    If the service has different generations of hardware, for the same SKU, then that can be captured here.

    Size string

    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    Tier string

    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    Name string

    The name of the SKU. Ex - P3. It is typically a letter+number code

    Capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    Family string

    If the service has different generations of hardware, for the same SKU, then that can be captured here.

    Size string

    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    Tier string

    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    name String

    The name of the SKU. Ex - P3. It is typically a letter+number code

    capacity Integer

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    family String

    If the service has different generations of hardware, for the same SKU, then that can be captured here.

    size String

    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier String

    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    name string

    The name of the SKU. Ex - P3. It is typically a letter+number code

    capacity number

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    family string

    If the service has different generations of hardware, for the same SKU, then that can be captured here.

    size string

    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier string

    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    name str

    The name of the SKU. Ex - P3. It is typically a letter+number code

    capacity int

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    family str

    If the service has different generations of hardware, for the same SKU, then that can be captured here.

    size str

    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier str

    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    name String

    The name of the SKU. Ex - P3. It is typically a letter+number code

    capacity Number

    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

    family String

    If the service has different generations of hardware, for the same SKU, then that can be captured here.

    size String

    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier String

    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    SystemDataResponse

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    createdAt string

    The timestamp of resource creation (UTC).

    createdBy string

    The identity that created the resource.

    createdByType string

    The type of identity that created the resource.

    lastModifiedAt string

    The timestamp of resource last modification (UTC)

    lastModifiedBy string

    The identity that last modified the resource.

    lastModifiedByType string

    The type of identity that last modified the resource.

    created_at str

    The timestamp of resource creation (UTC).

    created_by str

    The identity that created the resource.

    created_by_type str

    The type of identity that created the resource.

    last_modified_at str

    The timestamp of resource last modification (UTC)

    last_modified_by str

    The identity that last modified the resource.

    last_modified_by_type str

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi