azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations
name: EnvironmentDefinitionsOperations
fullName: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations
module: azure.mgmt.devcenter.aio.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.devcenter.aio.DevCenterMgmtClient>'s\n\
  >\n> <xref:environment_definitions> attribute.\n>"
constructor:
  syntax: EnvironmentDefinitionsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.get
  name: get
  summary: Gets an environment definition from the catalog.
  signature: 'async get(resource_group_name: str, dev_center_name: str, catalog_name:
    str, environment_definition_name: str, **kwargs: Any) -> EnvironmentDefinition'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: dev_center_name
    description: The name of the devcenter. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: catalog_name
    description: The name of the Catalog. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: environment_definition_name
    description: The name of the Environment Definition. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: EnvironmentDefinition or the result of cls(response)
    types:
    - <xref:azure.mgmt.devcenter.models.EnvironmentDefinition>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.get_by_project_catalog
  name: get_by_project_catalog
  summary: Gets an environment definition from the catalog.
  signature: 'async get_by_project_catalog(resource_group_name: str, project_name:
    str, catalog_name: str, environment_definition_name: str, **kwargs: Any) -> EnvironmentDefinition'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: project_name
    description: The name of the project. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: catalog_name
    description: The name of the Catalog. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: environment_definition_name
    description: The name of the Environment Definition. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: EnvironmentDefinition or the result of cls(response)
    types:
    - <xref:azure.mgmt.devcenter.models.EnvironmentDefinition>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.get_error_details
  name: get_error_details
  summary: Gets Environment Definition error details.
  signature: 'async get_error_details(resource_group_name: str, dev_center_name: str,
    catalog_name: str, environment_definition_name: str, **kwargs: Any) -> CatalogResourceValidationErrorDetails'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: dev_center_name
    description: The name of the devcenter. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: catalog_name
    description: The name of the Catalog. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: environment_definition_name
    description: The name of the Environment Definition. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: CatalogResourceValidationErrorDetails or the result of cls(response)
    types:
    - <xref:azure.mgmt.devcenter.models.CatalogResourceValidationErrorDetails>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.list_by_catalog
  name: list_by_catalog
  summary: List environment definitions in the catalog.
  signature: 'list_by_catalog(resource_group_name: str, dev_center_name: str, catalog_name:
    str, top: int | None = None, **kwargs: Any) -> AsyncIterable[EnvironmentDefinition]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: dev_center_name
    description: The name of the devcenter. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: catalog_name
    description: The name of the Catalog. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: 'The maximum number of resources to return from the operation. Example:
      ''$top=10''.

      Default value is None.'
    isRequired: true
    types:
    - <xref:int>
  return:
    description: 'An iterator like instance of either EnvironmentDefinition or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.devcenter.models.EnvironmentDefinition>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.list_by_project_catalog
  name: list_by_project_catalog
  summary: Lists the environment definitions in this project catalog.
  signature: 'list_by_project_catalog(resource_group_name: str, project_name: str,
    catalog_name: str, **kwargs: Any) -> AsyncIterable[EnvironmentDefinition]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: project_name
    description: The name of the project. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: catalog_name
    description: The name of the Catalog. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either EnvironmentDefinition or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.devcenter.models.EnvironmentDefinition>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.devcenter.aio.operations.EnvironmentDefinitionsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.devcenter.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\devcenter\\models\\__init__.py'>