Quotas - List

Servicio:

Azure Quantum

Versión de la API:

2024-10-01-preview

Enumerar las cuotas del área de trabajo especificada.

GET https://{region}.{serviceBaseUrl}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas?api-version=2024-10-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
region	path	True	string	Región de Azure donde se encuentra el área de trabajo de Azure Quantum.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$	Nombre del grupo de recursos de Azure.
serviceBaseUrl	path	True	string	Dirección URL base del servicio Azure Quantum.
subscriptionId	path	True	string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$	Identificador de suscripción de Azure.
workspaceName	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$	Nombre del área de trabajo de Azure Quantum.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	PagedQuota	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

AzureEntraAuth

Autenticación de Azure Entra OAuth2

Tipo: oauth2
Flujo: application
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

Nombre	Description
https://quantum.microsoft.com/.default

x-ms-quantum-api-key

Autenticación de Azure Api-Key

Tipo: apiKey
En: header

Ejemplos

Get workspace quotas.

Solicitud de ejemplo

HTTP

GET https://{region}.{serviceBaseUrl}/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Quantum/workspaces/my-workspace/quotas?api-version=2024-10-01-preview

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "dimension": "free_combined_job_hours",
      "scope": "Subscription",
      "providerId": "Microsoft",
      "utilization": 0.001756120333333333,
      "holds": 0.016666666666666666,
      "limit": 15,
      "period": "Monthly"
    },
    {
      "dimension": "free_fpga_job_hours",
      "scope": "Workspace",
      "providerId": "Microsoft",
      "utilization": 0,
      "holds": 0,
      "limit": 0.25,
      "period": "Monthly"
    },
    {
      "dimension": "free_combined_job_hours",
      "scope": "Workspace",
      "providerId": "Microsoft",
      "utilization": 0.0017561203333333335,
      "holds": 0,
      "limit": 1,
      "period": "Monthly"
    },
    {
      "dimension": "concurrent_cpu_jobs",
      "scope": "Workspace",
      "providerId": "Microsoft",
      "utilization": 0,
      "holds": 0,
      "limit": 10,
      "period": "None"
    },
    {
      "dimension": "concurrent_fpga_jobs",
      "scope": "Workspace",
      "providerId": "Microsoft",
      "utilization": 0,
      "holds": 0,
      "limit": 1,
      "period": "None"
    }
  ],
  "nextLink": null
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DimensionScope	Ámbito al que se aplica la cuota.
MeterPeriod	Período de tiempo en el que se acumula el medidor subyacente de la cuota. Basado en el año natural. 'None' se usa para cuotas simultáneas.
PagedQuota	Colección paginada de elementos de cuota
Quota	Información de cuota.

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

DimensionScope

Enumeración

Ámbito al que se aplica la cuota.

Valor	Description
Subscription	La cuota se aplica a la suscripción de Azure.
Workspace	La cuota se aplica al área de trabajo de Quantum.

MeterPeriod

Enumeración

Período de tiempo en el que se acumula el medidor subyacente de la cuota. Basado en el año natural. 'None' se usa para cuotas simultáneas.

Valor	Description
Monthly	El período de medidor es por mes.
None	El período de medidor es instantáneo. Se usa para cuotas simultáneas.

PagedQuota

Object

Colección paginada de elementos de cuota

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Quota[]	Elementos de cuota de esta página

Quota

Object

Información de cuota.

Nombre	Tipo	Description
dimension	string	Nombre de la dimensión asociada a la cuota.
holds	number (float)	Cantidad del uso que se ha reservado pero no aplicado para el período actual.
limit	number (float)	Cantidad máxima de uso permitida para el período actual.
period	MeterPeriod	Período de tiempo en el que se acumula el medidor subyacente de la cuota. Basado en el año natural. 'None' se usa para cuotas simultáneas.
providerId	string	Identificador único del proveedor.
scope	DimensionScope	Ámbito en el que se aplica la cuota.
utilization	number (float)	Cantidad del uso que se ha aplicado durante el período actual.