Module - Get

Servicio:

Automation

Versión de la API:

2023-11-01

Recupere el módulo identificado por el nombre del módulo.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}?api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
automationAccountName	path	True	string	Nombre de la cuenta de Automation.
moduleName	path	True	string	Nombre del módulo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nombre de un grupo de recursos de Azure.
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	Module	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error de Automation que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get a module

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources?api-version=2023-11-01

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources",
  "name": "OmsCompositeResources",
  "type": "Microsoft.Automation/AutomationAccounts/Modules",
  "location": "East US 2",
  "tags": {},
  "etag": null,
  "properties": {
    "isGlobal": false,
    "version": null,
    "sizeInBytes": 0,
    "activityCount": 0,
    "creationTime": "2017-03-29T15:41:47.003+00:00",
    "lastModifiedTime": "2017-03-29T15:42:10.567+00:00",
    "error": {
      "code": null,
      "message": ""
    },
    "provisioningState": "Creating",
    "isComposite": true
  }
}

Definiciones

Nombre	Description
ContentHash	Definición del tipo de propiedad runbook.
ContentLink	Definición del vínculo de contenido.
ErrorResponse	Respuesta de error de un error de operación
Module	Definición del tipo de módulo.
ModuleErrorInfo	Definición del tipo de información de error del módulo.
ModuleProvisioningState	Obtiene el estado de aprovisionamiento del módulo.

ContentHash

Object

Definición del tipo de propiedad runbook.

Nombre	Tipo	Description
algorithm	string	Obtiene o establece el algoritmo hash de contenido utilizado para aplicar un hash al contenido.
value	string	Obtiene o establece el valor hash esperado del contenido.

ContentLink

Object

Definición del vínculo de contenido.

Nombre	Tipo	Description
contentHash	ContentHash	Establece el hash.
uri	string	Establece el URI del contenido.
version	string	Establece la versión del contenido.

ErrorResponse

Object

Respuesta de error de un error de operación

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

Module

Object

Definición del tipo de módulo.

Nombre	Tipo	Description
etag	string	Obtiene la etiqueta etag del recurso.
id	string	Identificador de recurso completo para el recurso
location	string	Región de Azure donde reside el recurso
name	string	Nombre del recurso
properties.activityCount	integer (int32)	Obtiene el recuento de actividades del módulo.
properties.contentLink	ContentLink	Obtiene o establece el contentLink del módulo.
properties.creationTime	string (date-time)	Obtiene la hora de creación.
properties.description	string	Obtiene o establece la descripción.
properties.error	ModuleErrorInfo	Obtiene la información de error del módulo.
properties.isComposite	boolean	Obtiene el tipo de módulo, si está compuesto o no.
properties.isGlobal	boolean	Obtiene la marca isGlobal del módulo.
properties.lastModifiedTime	string (date-time)	Obtiene la hora de la última modificación.
properties.provisioningState	ModuleProvisioningState	Obtiene el estado de aprovisionamiento del módulo.
properties.sizeInBytes	integer (int64)	Obtiene el tamaño en bytes del módulo.
properties.version	string	Obtiene la versión del módulo.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso.

ModuleErrorInfo

Object

Definición del tipo de información de error del módulo.

Nombre	Tipo	Description
code	string	Obtiene el código de error.
message	string	Obtiene el mensaje de error.

ModuleProvisioningState

Enumeración

Obtiene el estado de aprovisionamiento del módulo.

Valor	Description
ActivitiesStored
Canceled
ConnectionTypeImported
ContentDownloaded
ContentRetrieved
ContentStored
ContentValidated
Created
Creating
Failed
ModuleDataStored
ModuleImportRunbookComplete
RunningImportModuleRunbook
StartingImportModuleRunbook
Succeeded
Updating