azure-native.devcenter.getDevBoxDefinition
Explore with Pulumi AI
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:
- Dev
Box stringDefinition Name The name of the Dev Box definition.
- Dev
Center stringName The name of the devcenter.
- Resource
Group stringName Name of the resource group within the Azure subscription.
- Dev
Box stringDefinition Name The name of the Dev Box definition.
- Dev
Center stringName The name of the devcenter.
- Resource
Group stringName Name of the resource group within the Azure subscription.
- dev
Box StringDefinition Name The name of the Dev Box definition.
- dev
Center StringName The name of the devcenter.
- resource
Group StringName Name of the resource group within the Azure subscription.
- dev
Box stringDefinition Name The name of the Dev Box definition.
- dev
Center stringName The name of the devcenter.
- resource
Group stringName Name of the resource group within the Azure subscription.
- dev_
box_ strdefinition_ name The name of the Dev Box definition.
- dev_
center_ strname The name of the devcenter.
- resource_
group_ strname Name of the resource group within the Azure subscription.
- dev
Box StringDefinition Name The name of the Dev Box definition.
- dev
Center StringName The name of the devcenter.
- resource
Group StringName Name of the resource group within the Azure subscription.
getDevBoxDefinition Result
The following output properties are available:
- Active
Image Pulumi.Reference Azure Native. Dev Center. Outputs. Image Reference Response 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}
- Image
Reference Pulumi.Azure Native. Dev Center. Outputs. Image Reference Response Image reference information.
- Image
Validation Pulumi.Error Details Azure Native. Dev Center. Outputs. Image Validation Error Details Response Details for image validator error. Populated when the image validation is not successful.
- Image
Validation stringStatus Validation status of the configured image.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Os
Storage stringType The storage type used for the Operating System disk of Dev Boxes created using this definition.
- Provisioning
State string The provisioning state of the resource.
- Sku
Pulumi.
Azure Native. Dev Center. Outputs. Sku Response The SKU for Dev Boxes created using this definition.
- System
Data Pulumi.Azure Native. Dev Center. Outputs. System Data Response 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"
- Dictionary<string, string>
Resource tags.
- Active
Image ImageReference Reference Response 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}
- Image
Reference ImageReference Response Image reference information.
- Image
Validation ImageError Details Validation Error Details Response Details for image validator error. Populated when the image validation is not successful.
- Image
Validation stringStatus Validation status of the configured image.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Os
Storage stringType The storage type used for the Operating System disk of Dev Boxes created using this definition.
- Provisioning
State string The provisioning state of the resource.
- Sku
Sku
Response The SKU for Dev Boxes created using this definition.
- System
Data SystemData Response 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"
- map[string]string
Resource tags.
- active
Image ImageReference Reference Response 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}
- image
Reference ImageReference Response Image reference information.
- image
Validation ImageError Details Validation Error Details Response Details for image validator error. Populated when the image validation is not successful.
- image
Validation StringStatus Validation status of the configured image.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- os
Storage StringType The storage type used for the Operating System disk of Dev Boxes created using this definition.
- provisioning
State String The provisioning state of the resource.
- sku
Sku
Response The SKU for Dev Boxes created using this definition.
- system
Data SystemData Response 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"
- Map<String,String>
Resource tags.
- active
Image ImageReference Reference Response 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}
- image
Reference ImageReference Response Image reference information.
- image
Validation ImageError Details Validation Error Details Response Details for image validator error. Populated when the image validation is not successful.
- image
Validation stringStatus Validation status of the configured image.
- location string
The geo-location where the resource lives
- name string
The name of the resource
- os
Storage stringType The storage type used for the Operating System disk of Dev Boxes created using this definition.
- provisioning
State string The provisioning state of the resource.
- sku
Sku
Response The SKU for Dev Boxes created using this definition.
- system
Data SystemData Response 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"
- {[key: string]: string}
Resource tags.
- active_
image_ Imagereference Reference Response 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 ImageReference Response Image reference information.
- image_
validation_ Imageerror_ details Validation Error Details Response Details for image validator error. Populated when the image validation is not successful.
- image_
validation_ strstatus Validation status of the configured image.
- location str
The geo-location where the resource lives
- name str
The name of the resource
- os_
storage_ strtype 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
Sku
Response The SKU for Dev Boxes created using this definition.
- system_
data SystemData Response 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"
- Mapping[str, str]
Resource tags.
- active
Image Property MapReference 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}
- image
Reference Property Map Image reference information.
- image
Validation Property MapError Details Details for image validator error. Populated when the image validation is not successful.
- image
Validation StringStatus Validation status of the configured image.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- os
Storage StringType The storage type used for the Operating System disk of Dev Boxes created using this definition.
- provisioning
State String The provisioning state of the resource.
- sku Property Map
The SKU for Dev Boxes created using this definition.
- system
Data 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"
- Map<String>
Resource tags.
Supporting Types
ImageReferenceResponse
- Exact
Version 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 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 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 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.
- exact
Version 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
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
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0