Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. programenrollment
  6. getEduEnrollment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.programenrollment.getEduEnrollment

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets the specified edu enrollment.

    Uses Azure REST API version 2026-03-01-preview.

    Using getEduEnrollment

    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 getEduEnrollment(args: GetEduEnrollmentArgs, opts?: InvokeOptions): Promise<GetEduEnrollmentResult>
function getEduEnrollmentOutput(args: GetEduEnrollmentOutputArgs, opts?: InvokeOptions): Output<GetEduEnrollmentResult>
    def get_edu_enrollment(enrollment_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetEduEnrollmentResult
def get_edu_enrollment_output(enrollment_name: pulumi.Input[Optional[str]] = None,
                       resource_group_name: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetEduEnrollmentResult]
    func LookupEduEnrollment(ctx *Context, args *LookupEduEnrollmentArgs, opts ...InvokeOption) (*LookupEduEnrollmentResult, error)
func LookupEduEnrollmentOutput(ctx *Context, args *LookupEduEnrollmentOutputArgs, opts ...InvokeOption) LookupEduEnrollmentResultOutput

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

    public static class GetEduEnrollment 
{
    public static Task<GetEduEnrollmentResult> InvokeAsync(GetEduEnrollmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEduEnrollmentResult> Invoke(GetEduEnrollmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEduEnrollmentResult> getEduEnrollment(GetEduEnrollmentArgs args, InvokeOptions options)
public static Output<GetEduEnrollmentResult> getEduEnrollment(GetEduEnrollmentArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:programenrollment:getEduEnrollment
  arguments:
    # arguments dictionary
    data "azure-native_programenrollment_get_edu_enrollment" "name" {
    # arguments
}

    The following arguments are supported:

    EnrollmentName string
    The name of the edu enrollment
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    EnrollmentName string
    The name of the edu enrollment
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    enrollment_name string
    The name of the edu enrollment
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    enrollmentName String
    The name of the edu enrollment
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    enrollmentName string
    The name of the edu enrollment
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    enrollment_name str
    The name of the edu enrollment
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    enrollmentName String
    The name of the edu enrollment
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getEduEnrollment Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.ProgramEnrollment.Outputs.EduEnrollmentPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.ProgramEnrollment.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.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties EduEnrollmentPropertiesResponse
    The resource-specific properties for this resource.
    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.
    azure_api_version string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties object
    The resource-specific properties for this resource.
    system_data object
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties EduEnrollmentPropertiesResponse
    The resource-specific properties for this resource.
    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.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties EduEnrollmentPropertiesResponse
    The resource-specific properties for this resource.
    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.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties EduEnrollmentPropertiesResponse
    The resource-specific properties for this resource.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    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

    DomainGroupResponse

    DomainNames List<string>
    The edu domain names in this group.
    FailureReason Pulumi.AzureNative.ProgramEnrollment.Inputs.ErrorDetailResponse
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    State string
    The assessment state of this domain group.
    TenantId string
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.
    DomainNames []string
    The edu domain names in this group.
    FailureReason ErrorDetailResponse
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    State string
    The assessment state of this domain group.
    TenantId string
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.
    domain_names list(string)
    The edu domain names in this group.
    failure_reason object
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    state string
    The assessment state of this domain group.
    tenant_id string
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.
    domainNames List<String>
    The edu domain names in this group.
    failureReason ErrorDetailResponse
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    state String
    The assessment state of this domain group.
    tenantId String
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.
    domainNames string[]
    The edu domain names in this group.
    failureReason ErrorDetailResponse
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    state string
    The assessment state of this domain group.
    tenantId string
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.
    domain_names Sequence[str]
    The edu domain names in this group.
    failure_reason ErrorDetailResponse
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    state str
    The assessment state of this domain group.
    tenant_id str
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.
    domainNames List<String>
    The edu domain names in this group.
    failureReason Property Map
    Failure detail when state is Failed or ActionRequired. Omitted otherwise.
    state String
    The assessment state of this domain group.
    tenantId String
    The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted.

    EduEnrollmentPropertiesResponse

    Domains List<Pulumi.AzureNative.ProgramEnrollment.Inputs.DomainGroupResponse>
    The domain groups associated with this enrollment.
    FailureReason Pulumi.AzureNative.ProgramEnrollment.Inputs.ErrorDetailResponse
    Failure detail when provisioningState is Failed. Omitted otherwise.
    ProvisioningState string
    The status of the last operation.
    Domains []DomainGroupResponse
    The domain groups associated with this enrollment.
    FailureReason ErrorDetailResponse
    Failure detail when provisioningState is Failed. Omitted otherwise.
    ProvisioningState string
    The status of the last operation.
    domains list(object)
    The domain groups associated with this enrollment.
    failure_reason object
    Failure detail when provisioningState is Failed. Omitted otherwise.
    provisioning_state string
    The status of the last operation.
    domains List<DomainGroupResponse>
    The domain groups associated with this enrollment.
    failureReason ErrorDetailResponse
    Failure detail when provisioningState is Failed. Omitted otherwise.
    provisioningState String
    The status of the last operation.
    domains DomainGroupResponse[]
    The domain groups associated with this enrollment.
    failureReason ErrorDetailResponse
    Failure detail when provisioningState is Failed. Omitted otherwise.
    provisioningState string
    The status of the last operation.
    domains Sequence[DomainGroupResponse]
    The domain groups associated with this enrollment.
    failure_reason ErrorDetailResponse
    Failure detail when provisioningState is Failed. Omitted otherwise.
    provisioning_state str
    The status of the last operation.
    domains List<Property Map>
    The domain groups associated with this enrollment.
    failureReason Property Map
    Failure detail when provisioningState is Failed. Omitted otherwise.
    provisioningState String
    The status of the last operation.

    ErrorAdditionalInfoResponse

    Info object
    The additional info.
    Type string
    The additional info type.
    Info interface{}
    The additional info.
    Type string
    The additional info type.
    info any
    The additional info.
    type string
    The additional info type.
    info Object
    The additional info.
    type String
    The additional info type.
    info any
    The additional info.
    type string
    The additional info type.
    info Any
    The additional info.
    type str
    The additional info type.
    info Any
    The additional info.
    type String
    The additional info type.

    ErrorDetailResponse

    AdditionalInfo []ErrorAdditionalInfoResponse
    The error additional info.
    Code string
    The error code.
    Details []ErrorDetailResponse
    The error details.
    Message string
    The error message.
    Target string
    The error target.
    additional_info list(object)
    The error additional info.
    code string
    The error code.
    details list(object)
    The error details.
    message string
    The error message.
    target string
    The error target.
    additionalInfo List<ErrorAdditionalInfoResponse>
    The error additional info.
    code String
    The error code.
    details List<ErrorDetailResponse>
    The error details.
    message String
    The error message.
    target String
    The error target.
    additionalInfo ErrorAdditionalInfoResponse[]
    The error additional info.
    code string
    The error code.
    details ErrorDetailResponse[]
    The error details.
    message string
    The error message.
    target string
    The error target.
    additional_info Sequence[ErrorAdditionalInfoResponse]
    The error additional info.
    code str
    The error code.
    details Sequence[ErrorDetailResponse]
    The error details.
    message str
    The error message.
    target str
    The error target.
    additionalInfo List<Property Map>
    The error additional info.
    code String
    The error code.
    details List<Property Map>
    The error details.
    message String
    The error message.
    target String
    The error target.

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.23.0
    published on Saturday, Jul 18, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial