azure.mgmt.devopsinfrastructure.models module

class azure.mgmt.devopsinfrastructure.models.AgentProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

The agent profile of the machines in the pool.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Stateful, StatelessAgentProfile

Variables:

  • kind (str) – Discriminator property for AgentProfile. Required. Default value is None.

  • resource_predictions (ResourcePredictions) – Defines pool buffer/stand-by agents.

  • resource_predictions_profile (ResourcePredictionsProfile) – Defines how the pool buffer/stand-by agents is provided.

kind: str

Discriminator property for AgentProfile. Required. Default value is None.

resource_predictions: _models.ResourcePredictions | None

Defines pool buffer/stand-by agents.

resource_predictions_profile: _models.ResourcePredictionsProfile | None

Defines how the pool buffer/stand-by agents is provided.

class azure.mgmt.devopsinfrastructure.models.AutomaticResourcePredictionsProfile(*args: Any, **kwargs: Any)[source]

Bases: ResourcePredictionsProfile

The stand-by agent scheme is determined based on historical demand.

Variables:

  • kind (str or AUTOMATIC) – The stand-by agent scheme is determined based on historical demand. Required. The stand-by agent scheme is determined based on historical demand.

  • prediction_preference (str or PredictionPreference) – Determines the balance between cost and performance. Known values are: “Balanced”, “MostCostEffective”, “MoreCostEffective”, “MorePerformance”, and “BestPerformance”.

kind: Literal[ResourcePredictionsProfileType.AUTOMATIC]

The stand-by agent scheme is determined based on historical demand. Required. The stand-by agent scheme is determined based on historical demand.

prediction_preference: str | _models.PredictionPreference | None

“Balanced”, “MostCostEffective”, “MoreCostEffective”, “MorePerformance”, and “BestPerformance”.

Type:

Determines the balance between cost and performance. Known values are

class azure.mgmt.devopsinfrastructure.models.AzureDevOpsOrganizationProfile(*args: Any, **kwargs: Any)[source]

Bases: OrganizationProfile

Azure DevOps organization profile.

Variables:

  • kind (str) – Azure DevOps organization profile. Required. Default value is “AzureDevOps”.

  • organizations (list[Organization]) – The list of Azure DevOps organizations the pool should be present in. Required.

  • permission_profile (AzureDevOpsPermissionProfile) – The type of permission which determines which accounts are admins on the Azure DevOps pool.

kind: Literal['AzureDevOps']

Azure DevOps organization profile. Required. Default value is “AzureDevOps”.

organizations: List[_models.Organization]

The list of Azure DevOps organizations the pool should be present in. Required.

permission_profile: _models.AzureDevOpsPermissionProfile | None

The type of permission which determines which accounts are admins on the Azure DevOps pool.

class azure.mgmt.devopsinfrastructure.models.AzureDevOpsPermissionProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Defines the type of Azure DevOps pool permission.

Variables:

  • kind (str or AzureDevOpsPermissionType) – Determines who has admin permissions to the Azure DevOps pool. Required. Known values are: “Inherit”, “CreatorOnly”, and “SpecificAccounts”.

  • users (list[str]) – User email addresses.

  • groups (list[str]) – Group email addresses.

groups: List[str] | None

Group email addresses.

kind: str | _models.AzureDevOpsPermissionType

Determines who has admin permissions to the Azure DevOps pool. Required. Known values are: “Inherit”, “CreatorOnly”, and “SpecificAccounts”.

users: List[str] | None

User email addresses.

class azure.mgmt.devopsinfrastructure.models.AzureDevOpsPermissionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Determines who has admin permissions to the Azure DevOps pool.

CREATOR_ONLY = 'CreatorOnly'

Only the pool creator will be an admin of the pool.

INHERIT = 'Inherit'

Pool will inherit permissions from the project or organization.

SPECIFIC_ACCOUNTS = 'SpecificAccounts'

Only the specified accounts will be admins of the pool.

class azure.mgmt.devopsinfrastructure.models.CachingType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of caching in a data disk.

NONE = 'None'

Don’t use host caching.

READ_ONLY = 'ReadOnly'

For workloads that only do read operations.

READ_WRITE = 'ReadWrite'

For workloads that do a balance of read and write operations.

class azure.mgmt.devopsinfrastructure.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The kind of entity that created the resource.

APPLICATION = 'Application'

The entity was created by an application.

KEY = 'Key'

The entity was created by a key.

MANAGED_IDENTITY = 'ManagedIdentity'

The entity was created by a managed identity.

USER = 'User'

The entity was created by a user.

class azure.mgmt.devopsinfrastructure.models.DataDisk(*args: Any, **kwargs: Any)[source]

Bases: Model

The data disk of the VMSS.

Variables:

  • caching (str or CachingType) – The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

  • disk_size_gi_b (int) – The initial disk size in gigabytes.

  • storage_account_type (str or StorageAccountType) – The storage Account type to be used for the data disk. If omitted, the default is “standard_lrs”. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “Premium_ZRS”, and “StandardSSD_ZRS”.

  • drive_letter (str) – The drive letter for the empty data disk. If not specified, it will be the first available letter.

caching: str | _models.CachingType | None

The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

disk_size_gi_b: int | None

The initial disk size in gigabytes.

drive_letter: str | None

The drive letter for the empty data disk. If not specified, it will be the first available letter.

storage_account_type: str | _models.StorageAccountType | None

The storage Account type to be used for the data disk. If omitted, the default is “standard_lrs”. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “Premium_ZRS”, and “StandardSSD_ZRS”.

class azure.mgmt.devopsinfrastructure.models.DevOpsAzureSku(*args: Any, **kwargs: Any)[source]

Bases: Model

The Azure SKU of the machines in the pool.

Variables:

name (str) – The Azure SKU name of the machines in the pool. Required.

name: str

The Azure SKU name of the machines in the pool. Required.

class azure.mgmt.devopsinfrastructure.models.ErrorAdditionalInfo(*args: Any, **kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str) – The additional info type.

  • info (any) – The additional info.

info: Any | None

The additional info.

type: str | None

The additional info type.

class azure.mgmt.devopsinfrastructure.models.ErrorDetail(*args: Any, **kwargs: Any)[source]

Bases: Model

The error detail.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:
additional_info: List[_models.ErrorAdditionalInfo] | None

The error additional info.

code: str | None

The error code.

details: List[_models.ErrorDetail] | None

The error details.

message: str | None

The error message.

target: str | None

The error target.

class azure.mgmt.devopsinfrastructure.models.ErrorResponse(*args: Any, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Variables:

error (ErrorDetail) – The error object.

error: _models.ErrorDetail | None

The error object.

class azure.mgmt.devopsinfrastructure.models.FabricProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Defines the type of fabric the agent will run on.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: VmssFabricProfile

Variables:

kind (str) – Discriminator property for FabricProfile. Required. Default value is None.

kind: str

Discriminator property for FabricProfile. Required. Default value is None.

class azure.mgmt.devopsinfrastructure.models.GitHubOrganization(*args: Any, **kwargs: Any)[source]

Bases: Model

Defines a GitHub organization.

Variables:

  • url (str) – The GitHub organization URL in which the pool should be created. Required.

  • repositories (list[str]) – Optional list of repositories in which the pool should be created.

repositories: List[str] | None

Optional list of repositories in which the pool should be created.

url: str

The GitHub organization URL in which the pool should be created. Required.

class azure.mgmt.devopsinfrastructure.models.GitHubOrganizationProfile(*args: Any, **kwargs: Any)[source]

Bases: OrganizationProfile

GitHub organization profile.

Variables:

  • kind (str) – GitHub organization profile. Required. Default value is “GitHub”.

  • organizations (list[GitHubOrganization]) – The list of GitHub organizations/repositories the pool should be present in. Required.

kind: Literal['GitHub']

GitHub organization profile. Required. Default value is “GitHub”.

organizations: List[_models.GitHubOrganization]

The list of GitHub organizations/repositories the pool should be present in. Required.

class azure.mgmt.devopsinfrastructure.models.ImageVersion(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

An image version object.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ImageVersionProperties) – The resource-specific properties for this resource.

properties: _models.ImageVersionProperties | None

The resource-specific properties for this resource.

class azure.mgmt.devopsinfrastructure.models.ImageVersionProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the ImageVersionProperties.

Variables:

version (str) – Version of the image. Required.

version: str

Version of the image. Required.

class azure.mgmt.devopsinfrastructure.models.LogonType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Determines how the service should be run.

INTERACTIVE = 'Interactive'

Run in interactive mode.

SERVICE = 'Service'

Run as a service.

class azure.mgmt.devopsinfrastructure.models.ManagedServiceIdentity(*args: Any, **kwargs: Any)[source]

Bases: Model

Managed service identity (system assigned and/or user assigned identities).

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

  • tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

  • type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

principal_id: str | None

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenant_id: str | None

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type: str | _models.ManagedServiceIdentityType

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:

The type of managed identity assigned to this resource. Required. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None

The identities assigned to this resource by the user.

class azure.mgmt.devopsinfrastructure.models.ManagedServiceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NONE = 'None'

No managed identity.

SYSTEM_ASSIGNED = 'SystemAssigned'

System assigned managed identity.

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'

System and user assigned managed identity.

USER_ASSIGNED = 'UserAssigned'

User assigned managed identity.

class azure.mgmt.devopsinfrastructure.models.ManualResourcePredictionsProfile(*args: Any, **kwargs: Any)[source]

Bases: ResourcePredictionsProfile

Customer provides the stand-by agent scheme.

Variables:

kind (str or MANUAL) – Customer provides the stand-by agent scheme. Required. Customer provides the stand-by agent scheme.

kind: Literal[ResourcePredictionsProfileType.MANUAL]

Customer provides the stand-by agent scheme. Required. Customer provides the stand-by agent scheme.

class azure.mgmt.devopsinfrastructure.models.NetworkProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

The network profile of the machines in the pool.

Variables:

subnet_id (str) – The subnet id on which to put all machines created in the pool. Required.

subnet_id: str

The subnet id on which to put all machines created in the pool. Required.

class azure.mgmt.devopsinfrastructure.models.Organization(*args: Any, **kwargs: Any)[source]

Bases: Model

Defines an Azure DevOps organization.

Variables:

  • url (str) – The Azure DevOps organization URL in which the pool should be created. Required.

  • projects (list[str]) – Optional list of projects in which the pool should be created.

  • parallelism (int) – How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool.

parallelism: int | None

How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool.

projects: List[str] | None

Optional list of projects in which the pool should be created.

url: str

The Azure DevOps organization URL in which the pool should be created. Required.

class azure.mgmt.devopsinfrastructure.models.OrganizationProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Defines the organization in which the pool will be used.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureDevOpsOrganizationProfile, GitHubOrganizationProfile

Variables:

kind (str) – Discriminator property for OrganizationProfile. Required. Default value is None.

kind: str

Discriminator property for OrganizationProfile. Required. Default value is None.

class azure.mgmt.devopsinfrastructure.models.OsDiskStorageAccountType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The storage account type of the OS disk.

PREMIUM = 'Premium'

Premium OS disk type.

STANDARD = 'Standard'

Standard OS disk type.

STANDARD_SSD = 'StandardSSD'

Standard SSD OS disk type.

class azure.mgmt.devopsinfrastructure.models.OsProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

The OS profile of the machines in the pool.

Variables:

  • secrets_management_settings (SecretsManagementSettings) – The secret management settings of the machines in the pool.

  • logon_type (str or LogonType) – Determines how the service should be run. By default, this will be set to Service. Known values are: “Service” and “Interactive”.

logon_type: str | _models.LogonType | None

Determines how the service should be run. By default, this will be set to Service. Known values are: “Service” and “Interactive”.

secrets_management_settings: _models.SecretsManagementSettings | None

The secret management settings of the machines in the pool.

class azure.mgmt.devopsinfrastructure.models.Pool(*args: Any, **kwargs: Any)[source]

Bases: TrackedResource

Concrete tracked resource types can be created by aliasing this type using a specific property type.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (PoolProperties) – The resource-specific properties for this resource.

  • identity (ManagedServiceIdentity) – The managed service identities assigned to this resource.

identity: _models.ManagedServiceIdentity | None

The managed service identities assigned to this resource.

properties: _models.PoolProperties | None

The resource-specific properties for this resource.

class azure.mgmt.devopsinfrastructure.models.PoolImage(*args: Any, **kwargs: Any)[source]

Bases: Model

The VM image of the machines in the pool.

Variables:

  • resource_id (str) – The resource id of the image.

  • well_known_image_name (str) – The image to use from a well-known set of images made available to customers.

  • aliases (list[str]) – List of aliases to reference the image by.

  • buffer (str) – The percentage of the buffer to be allocated to this image.

aliases: List[str] | None

List of aliases to reference the image by.

buffer: str | None

The percentage of the buffer to be allocated to this image.

resource_id: str | None

The resource id of the image.

well_known_image_name: str | None

The image to use from a well-known set of images made available to customers.

class azure.mgmt.devopsinfrastructure.models.PoolProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Pool properties.

Variables:

  • provisioning_state (str or ProvisioningState) – The status of the current operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.

  • maximum_concurrency (int) – Defines how many resources can there be created at any given time. Required.

  • organization_profile (OrganizationProfile) – Defines the organization in which the pool will be used. Required.

  • agent_profile (AgentProfile) – Defines how the machine will be handled once it executed a job. Required.

  • fabric_profile (FabricProfile) – Defines the type of fabric the agent will run on. Required.

  • dev_center_project_resource_id (str) – The resource id of the DevCenter Project the pool belongs to. Required.

agent_profile: _models.AgentProfile

Defines how the machine will be handled once it executed a job. Required.

dev_center_project_resource_id: str

The resource id of the DevCenter Project the pool belongs to. Required.

fabric_profile: _models.FabricProfile

Defines the type of fabric the agent will run on. Required.

maximum_concurrency: int

Defines how many resources can there be created at any given time. Required.

organization_profile: _models.OrganizationProfile

Defines the organization in which the pool will be used. Required.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.

Type:

The status of the current operation. Known values are

class azure.mgmt.devopsinfrastructure.models.PoolUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The type used for update operations of the Pool.

Variables:
identity: _models.ManagedServiceIdentity | None

The managed service identities assigned to this resource.

properties: _models.PoolUpdateProperties | None

The resource-specific properties for this resource.

tags: Dict[str, str] | None

Resource tags.

class azure.mgmt.devopsinfrastructure.models.PoolUpdateProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

The updatable properties of the Pool.

Variables:

  • provisioning_state (str or ProvisioningState) – The status of the current operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.

  • maximum_concurrency (int) – Defines how many resources can there be created at any given time.

  • organization_profile (OrganizationProfile) – Defines the organization in which the pool will be used.

  • agent_profile (AgentProfile) – Defines how the machine will be handled once it executed a job.

  • fabric_profile (FabricProfile) – Defines the type of fabric the agent will run on.

  • dev_center_project_resource_id (str) – The resource id of the DevCenter Project the pool belongs to.

agent_profile: _models.AgentProfile | None

Defines how the machine will be handled once it executed a job.

dev_center_project_resource_id: str | None

The resource id of the DevCenter Project the pool belongs to.

fabric_profile: _models.FabricProfile | None

Defines the type of fabric the agent will run on.

maximum_concurrency: int | None

Defines how many resources can there be created at any given time.

organization_profile: _models.OrganizationProfile | None

Defines the organization in which the pool will be used.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.

Type:

The status of the current operation. Known values are

class azure.mgmt.devopsinfrastructure.models.PredictionPreference(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Determines the balance between cost and performance.

BALANCED = 'Balanced'

Balance between cost and performance.

BEST_PERFORMANCE = 'BestPerformance'

Optimizes for performance over cost.

MORE_COST_EFFECTIVE = 'MoreCostEffective'

Halfway through cost and balanced.

MORE_PERFORMANCE = 'MorePerformance'

Halfway through balanced and performance.

MOST_COST_EFFECTIVE = 'MostCostEffective'

Optimizes for cost over performance.

class azure.mgmt.devopsinfrastructure.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The status of the current operation.

ACCEPTED = 'Accepted'

Represents an accepted operation.

CANCELED = 'Canceled'

Represents a canceled operation.

DELETING = 'Deleting'

Represents an operation under deletion.

FAILED = 'Failed'

Represents a failed operation.

PROVISIONING = 'Provisioning'

Represents a pending operation.

SUCCEEDED = 'Succeeded'

Represents a succeeded operation.

UPDATING = 'Updating'

Represents a pending operation.

class azure.mgmt.devopsinfrastructure.models.ProxyResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.devopsinfrastructure.models.Quota(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes Resource Quota.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (QuotaName) – The name of the quota.

  • id (str) – Fully qualified ARM resource id. Required.

  • unit (str) – The unit of usage measurement. Required.

  • current_value (int) – The current usage of the resource. Required.

  • limit (int) – The maximum permitted usage of the resource. Required.

current_value: int

The current usage of the resource. Required.

id: str

Fully qualified ARM resource id. Required.

limit: int

The maximum permitted usage of the resource. Required.

name: _models.QuotaName | None

The name of the quota.

unit: str

The unit of usage measurement. Required.

class azure.mgmt.devopsinfrastructure.models.QuotaName(*args: Any, **kwargs: Any)[source]

Bases: Model

The Quota Names.

Variables:

  • value (str) – The name of the resource.

  • localized_value (str) – The localized name of the resource.

localized_value: str | None

The localized name of the resource.

value: str | None

The name of the resource.

class azure.mgmt.devopsinfrastructure.models.Resource(*args: Any, **kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

id: str | None

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

name: str | None

The name of the resource.

system_data: _models.SystemData | None

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type: str | None

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

class azure.mgmt.devopsinfrastructure.models.ResourceDetailsObject(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

A ResourceDetailsObject.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ResourceDetailsObjectProperties) – The resource-specific properties for this resource.

properties: _models.ResourceDetailsObjectProperties | None

The resource-specific properties for this resource.

class azure.mgmt.devopsinfrastructure.models.ResourceDetailsObjectProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the ResourceDetailsObject.

Variables:

  • status (str or ResourceStatus) – The status of the resource. Required. Known values are: “Ready”, “NotReady”, “Allocated”, “PendingReturn”, “Returned”, “Leased”, “Provisioning”, “Updating”, “Starting”, “PendingReimage”, and “Reimaging”.

  • image (str) – The image name of the resource. Required.

  • image_version (str) – The version of the image running on the resource. Required.

image: str

The image name of the resource. Required.

image_version: str

The version of the image running on the resource. Required.

status: str | _models.ResourceStatus

“Ready”, “NotReady”, “Allocated”, “PendingReturn”, “Returned”, “Leased”, “Provisioning”, “Updating”, “Starting”, “PendingReimage”, and “Reimaging”.

Type:

The status of the resource. Required. Known values are

class azure.mgmt.devopsinfrastructure.models.ResourcePredictions(*args: Any, **kwargs: Any)[source]

Bases: Model

Defines pool buffer.

class azure.mgmt.devopsinfrastructure.models.ResourcePredictionsProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Determines how the stand-by scheme should be provided.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AutomaticResourcePredictionsProfile, ManualResourcePredictionsProfile

Variables:

kind (str or ResourcePredictionsProfileType) – Determines how the stand-by scheme should be provided. Required. Known values are: “Manual” and “Automatic”.

kind: str

“Manual” and “Automatic”.

Type:

Determines how the stand-by scheme should be provided. Required. Known values are

class azure.mgmt.devopsinfrastructure.models.ResourcePredictionsProfileType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Determines how the stand-by scheme should be provided.

AUTOMATIC = 'Automatic'

The stand-by agent scheme is determined based on historical demand.

MANUAL = 'Manual'

Customer provides the stand-by agent scheme.

class azure.mgmt.devopsinfrastructure.models.ResourceSku(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

A ResourceSku.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ResourceSkuProperties) – The resource-specific properties for this resource.

properties: _models.ResourceSkuProperties | None

The resource-specific properties for this resource.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuCapabilities(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes The SKU capabilities object.

Variables:

  • name (str) – The name of the SKU capability. Required.

  • value (str) – The value of the SKU capability. Required.

name: str

The name of the SKU capability. Required.

value: str

The value of the SKU capability. Required.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuLocationInfo(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes an available Compute SKU Location Information.

Variables:

  • location (str) – Location of the SKU. Required.

  • zones (list[str]) – List of availability zones where the SKU is supported. Required.

  • zone_details (list[ResourceSkuZoneDetails]) – Gets details of capabilities available to a SKU in specific zones. Required.

location: str

Location of the SKU. Required.

zone_details: List[_models.ResourceSkuZoneDetails]

Gets details of capabilities available to a SKU in specific zones. Required.

zones: List[str]

List of availability zones where the SKU is supported. Required.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Properties of a ResourceSku.

Variables:

  • resource_type (str) – The type of resource the SKU applies to. Required.

  • tier (str) – The tier of virtual machines in a scale set. Required.

  • size (str) – The size of the SKU. Required.

  • family (str) – The family of the SKU. Required.

  • locations (list[str]) – The set of locations that the SKU is available. Required.

  • location_info (list[ResourceSkuLocationInfo]) – A list of locations and availability zones in those locations where the SKU is available. Required.

  • capabilities (list[ResourceSkuCapabilities]) – Name value pairs to describe the capability. Required.

  • restrictions (list[ResourceSkuRestrictions]) – The restrictions of the SKU. Required.

capabilities: List[_models.ResourceSkuCapabilities]

Name value pairs to describe the capability. Required.

family: str

The family of the SKU. Required.

location_info: List[_models.ResourceSkuLocationInfo]

A list of locations and availability zones in those locations where the SKU is available. Required.

locations: List[str]

The set of locations that the SKU is available. Required.

resource_type: str

The type of resource the SKU applies to. Required.

restrictions: List[_models.ResourceSkuRestrictions]

The restrictions of the SKU. Required.

size: str

The size of the SKU. Required.

tier: str

The tier of virtual machines in a scale set. Required.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuRestrictionInfo(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes an available Compute SKU Restriction Information.

Variables:

  • locations (list[str]) – Locations where the SKU is restricted.

  • zones (list[str]) – List of availability zones where the SKU is restricted.

locations: List[str] | None

Locations where the SKU is restricted.

zones: List[str] | None

List of availability zones where the SKU is restricted.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuRestrictions(*args: Any, **kwargs: Any)[source]

Bases: Model

The restrictions of the SKU.

Variables:

  • type (str or ResourceSkuRestrictionsType) – the type of restrictions. Known values are: “Location” and “Zone”.

  • values_property (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. Required.

  • restriction_info (ResourceSkuRestrictionInfo) – The information about the restriction where the SKU cannot be used. Required.

  • reason_code (str or ResourceSkuRestrictionsReasonCode) – the reason for restriction. Known values are: “QuotaId” and “NotAvailableForSubscription”.

reason_code: str | _models.ResourceSkuRestrictionsReasonCode | None

“QuotaId” and “NotAvailableForSubscription”.

Type:

the reason for restriction. Known values are

restriction_info: _models.ResourceSkuRestrictionInfo

The information about the restriction where the SKU cannot be used. Required.

type: str | _models.ResourceSkuRestrictionsType | None

“Location” and “Zone”.

Type:

the type of restrictions. Known values are

values_property: List[str]

The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. Required.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuRestrictionsReasonCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Describes the reason for SKU restriction.

NOT_AVAILABLE_FOR_SUBSCRIPTION = 'NotAvailableForSubscription'

The restriction is not available for this subscription.

QUOTA_ID = 'QuotaId'

The restriction is due to exceeding a quota limitation.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuRestrictionsType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Describes the kind of SKU restrictions that can exist.

LOCATION = 'Location'

SKU restricted by location.

ZONE = 'Zone'

SKU restricted by availability zone.

class azure.mgmt.devopsinfrastructure.models.ResourceSkuZoneDetails(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes The zonal capabilities of a SKU.

Variables:

  • name (list[str]) – Gets the set of zones that the SKU is available in with the specified capabilities. Required.

  • capabilities (list[ResourceSkuCapabilities]) – A list of capabilities that are available for the SKU in the specified list of zones. Required.

capabilities: List[_models.ResourceSkuCapabilities]

A list of capabilities that are available for the SKU in the specified list of zones. Required.

name: List[str]

Gets the set of zones that the SKU is available in with the specified capabilities. Required.

class azure.mgmt.devopsinfrastructure.models.ResourceStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The status of the machine resource.

ALLOCATED = 'Allocated'

Represents a machine resource that is allocated.

LEASED = 'Leased'

Represents a machine resource that is leased.

NOT_READY = 'NotReady'

Represents a machine resource that is not ready.

PENDING_REIMAGE = 'PendingReimage'

Represents a machine resource that is pending reimage.

PENDING_RETURN = 'PendingReturn'

Represents a machine resource that is pending return.

PROVISIONING = 'Provisioning'

Represents a machine resource that is provisioning.

READY = 'Ready'

Represents a machine resource that is ready.

REIMAGING = 'Reimaging'

Represents a machine resource that is reimaging.

RETURNED = 'Returned'

Represents a machine resource that is returned.

STARTING = 'Starting'

Represents a machine resource that is starting.

UPDATING = 'Updating'

Represents a machine resource that is updating.

class azure.mgmt.devopsinfrastructure.models.SecretsManagementSettings(*args: Any, **kwargs: Any)[source]

Bases: Model

The secret management settings of the machines in the pool.

Variables:

  • certificate_store_location (str) – Where to store certificates on the machine.

  • observed_certificates (list[str]) – The list of certificates to install on all machines in the pool. Required.

  • key_exportable (bool) – Defines if the key of the certificates should be exportable. Required.

certificate_store_location: str | None

Where to store certificates on the machine.

key_exportable: bool

Defines if the key of the certificates should be exportable. Required.

observed_certificates: List[str]

The list of certificates to install on all machines in the pool. Required.

class azure.mgmt.devopsinfrastructure.models.Stateful(*args: Any, **kwargs: Any)[source]

Bases: AgentProfile

Stateful profile meaning that the machines will be returned to the pool after running a job.

Variables:

  • resource_predictions (ResourcePredictions) – Defines pool buffer/stand-by agents.

  • resource_predictions_profile (ResourcePredictionsProfile) – Defines how the pool buffer/stand-by agents is provided.

  • kind (str) – Stateful profile meaning that the machines will be returned to the pool after running a job. Required. Default value is “Stateful”.

  • max_agent_lifetime (str) – How long should stateful machines be kept around. The maximum is one week.

  • grace_period_time_span (str) – How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week.

grace_period_time_span: str | None

How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week.

kind: Literal['Stateful']

Stateful profile meaning that the machines will be returned to the pool after running a job. Required. Default value is “Stateful”.

max_agent_lifetime: str | None

How long should stateful machines be kept around. The maximum is one week.

class azure.mgmt.devopsinfrastructure.models.StatelessAgentProfile(*args: Any, **kwargs: Any)[source]

Bases: AgentProfile

Stateless profile meaning that the machines will be cleaned up after running a job.

Variables:

  • resource_predictions (ResourcePredictions) – Defines pool buffer/stand-by agents.

  • resource_predictions_profile (ResourcePredictionsProfile) – Defines how the pool buffer/stand-by agents is provided.

  • kind (str) – Stateless profile meaning that the machines will be cleaned up after running a job. Required. Default value is “Stateless”.

kind: Literal['Stateless']

Stateless profile meaning that the machines will be cleaned up after running a job. Required. Default value is “Stateless”.

class azure.mgmt.devopsinfrastructure.models.StorageAccountType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

StorageAccountType enums.

PREMIUM_LRS = 'Premium_LRS'

The data disk should use premium locally redundant storage.

PREMIUM_ZRS = 'Premium_ZRS'

The data disk should use premium SSD zonal redundant storage.

STANDARD_LRS = 'Standard_LRS'

The data disk should use standard locally redundant storage.

STANDARD_SSDLRS = 'StandardSSD_LRS'

The data disk should use standard SSD locally redundant storage.

STANDARD_SSDZRS = 'StandardSSD_ZRS'

The data disk should use standard SSD zonal redundant storage.

class azure.mgmt.devopsinfrastructure.models.StorageProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

The storage profile of the VMSS.

Variables:

  • os_disk_storage_account_type (str or OsDiskStorageAccountType) – The Azure SKU name of the machines in the pool. Known values are: “Standard”, “Premium”, and “StandardSSD”.

  • data_disks (list[DataDisk]) – A list of empty data disks to attach.

data_disks: List[_models.DataDisk] | None

A list of empty data disks to attach.

os_disk_storage_account_type: str | _models.OsDiskStorageAccountType | None

“Standard”, “Premium”, and “StandardSSD”.

Type:

The Azure SKU name of the machines in the pool. Known values are

class azure.mgmt.devopsinfrastructure.models.SystemData(*args: Any, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

created_at: datetime | None

The timestamp of resource creation (UTC).

created_by: str | None

The identity that created the resource.

created_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:

The type of identity that created the resource. Known values are

last_modified_at: datetime | None

The timestamp of resource last modification (UTC).

last_modified_by: str | None

The identity that last modified the resource.

last_modified_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:

The type of identity that last modified the resource. Known values are

class azure.mgmt.devopsinfrastructure.models.TrackedResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

location: str

The geo-location where the resource lives. Required.

tags: Dict[str, str] | None

Resource tags.

class azure.mgmt.devopsinfrastructure.models.UserAssignedIdentity(*args: Any, **kwargs: Any)[source]

Bases: Model

User assigned identity properties.

Readonly variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The principal ID of the assigned identity.

  • client_id (str) – The client ID of the assigned identity.

client_id: str | None

The client ID of the assigned identity.

principal_id: str | None

The principal ID of the assigned identity.

class azure.mgmt.devopsinfrastructure.models.VmssFabricProfile(*args: Any, **kwargs: Any)[source]

Bases: FabricProfile

The agents will run on Virtual Machine Scale Sets.

Variables:

  • kind (str) – Virtual Machine Scale Sets. Required. Default value is “Vmss”.

  • sku (DevOpsAzureSku) – The Azure SKU of the machines in the pool. Required.

  • images (list[PoolImage]) – The VM images of the machines in the pool. Required.

  • os_profile (OsProfile) – The OS profile of the machines in the pool.

  • storage_profile (StorageProfile) – The storage profile of the machines in the pool.

  • network_profile (NetworkProfile) – The network profile of the machines in the pool.

images: List[_models.PoolImage]

The VM images of the machines in the pool. Required.

kind: Literal['Vmss']

Virtual Machine Scale Sets. Required. Default value is “Vmss”.

network_profile: _models.NetworkProfile | None

The network profile of the machines in the pool.

os_profile: _models.OsProfile | None

The OS profile of the machines in the pool.

sku: _models.DevOpsAzureSku

The Azure SKU of the machines in the pool. Required.

storage_profile: _models.StorageProfile | None

The storage profile of the machines in the pool.