azure.batch.models.BatchJobScheduleCreateContent.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchJobScheduleCreateContent
name: BatchJobScheduleCreateContent
fullName: azure.batch.models.BatchJobScheduleCreateContent
module: azure.batch.models
summary: 'Parameters for creating an Azure Batch Job Schedule.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'BatchJobScheduleCreateContent(*args: Any, **kwargs: Any)'
variables:
- description: 'A string that uniquely identifies the schedule within the Account.
    The ID can contain

    any combination of alphanumeric characters including hyphens and underscores,
    and cannot

    contain more than 64 characters. The ID is case-preserving and case-insensitive
    (that is, you

    may not have two IDs within an Account that differ only by case). Required.'
  name: id
  types:
  - <xref:str>
- description: 'The display name for the schedule. The display name need not be unique
    and

    can contain any Unicode characters up to a maximum length of 1024.'
  name: display_name
  types:
  - <xref:str>
- description: 'The schedule according to which Jobs will be created. All times are
    fixed

    respective to UTC and are not impacted by daylight saving time. Required.'
  name: schedule
  types:
  - <xref:azure.batch.models.BatchJobScheduleConfiguration>
- description: The details of the Jobs to be created on this schedule. Required.
  name: job_specification
  types:
  - <xref:azure.batch.models.BatchJobSpecification>
- description: 'A list of name-value pairs associated with the schedule as metadata.
    The Batch

    service does not assign any meaning to metadata; it is solely for the use of user
    code.'
  name: metadata
  types:
  - <xref:list>[<xref:azure.batch.models.MetadataItem>]
methods:
- uid: azure.batch.models.BatchJobScheduleCreateContent.as_dict
  name: as_dict
  summary: Return a dict that can be JSONify using json.dump.
  signature: 'as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]'
  keywordOnlyParameters:
  - name: exclude_readonly
    description: Whether to remove the readonly properties.
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.BatchJobScheduleCreateContent.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchJobScheduleCreateContent.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchJobScheduleCreateContent.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchJobScheduleCreateContent.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchJobScheduleCreateContent.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchJobScheduleCreateContent.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchJobScheduleCreateContent.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchJobScheduleCreateContent.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchJobScheduleCreateContent.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchJobScheduleCreateContent.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchJobScheduleCreateContent.display_name
  name: display_name
  summary: 'The display name for the schedule. The display name need not be unique
    and can contain any

    Unicode characters up to a maximum length of 1024.'
  signature: 'display_name: str | None'
- uid: azure.batch.models.BatchJobScheduleCreateContent.id
  name: id
  summary: 'A string that uniquely identifies the schedule within the Account. The
    ID can contain any

    combination of alphanumeric characters including hyphens and underscores, and
    cannot contain

    more than 64 characters. The ID is case-preserving and case-insensitive (that
    is, you may not

    have two IDs within an Account that differ only by case). Required.'
  signature: 'id: str'
- uid: azure.batch.models.BatchJobScheduleCreateContent.job_specification
  name: job_specification
  summary: The details of the Jobs to be created on this schedule. Required.
  signature: 'job_specification: _models.BatchJobSpecification'
- uid: azure.batch.models.BatchJobScheduleCreateContent.metadata
  name: metadata
  summary: 'A list of name-value pairs associated with the schedule as metadata. The
    Batch service does not

    assign any meaning to metadata; it is solely for the use of user code.'
  signature: 'metadata: List[_models.MetadataItem] | None'
- uid: azure.batch.models.BatchJobScheduleCreateContent.schedule
  name: schedule
  summary: 'The schedule according to which Jobs will be created. All times are fixed
    respective to UTC and

    are not impacted by daylight saving time. Required.'
  signature: 'schedule: _models.BatchJobScheduleConfiguration'