Module - Get

Szolgáltatás:

Automation

API-verzió:

2023-11-01

Kérje le a modulnév alapján azonosított modult.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
automationAccountName	path	True	string	Az automation-fiók neve.
moduleName	path	True	string	A modul neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Egy Azure-erőforráscsoport neve.
subscriptionId	path	True	string	Lekéri az előfizetés hitelesítő adatait, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	Module	OKÉ
Other Status Codes	ErrorResponse	Automatizálási hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get a module

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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
  }
}

Definíciók

Name	Description
ContentHash	A runbook tulajdonságtípusának definíciója.
ContentLink	A tartalomhivatkozás definíciója.
ErrorResponse	Művelethiba hibaválasza
Module	A modultípus definíciója.
ModuleErrorInfo	A modul hibainformációs típusának meghatározása.
ModuleProvisioningState	Lekéri a modul kiépítési állapotát.

ContentHash

Objektum

A runbook tulajdonságtípusának definíciója.

Name	Típus	Description
algorithm	string	Lekéri vagy beállítja a tartalom kivonatolási algoritmusát.
value	string	Lekéri vagy beállítja a tartalom várt kivonatértékét.

ContentLink

Objektum

A tartalomhivatkozás definíciója.

Name	Típus	Description
contentHash	ContentHash	Beállítja a kivonatot.
uri	string	Beállítja a tartalom URI-ját.
version	string	Beállítja a tartalom verzióját.

ErrorResponse

Objektum

Művelethiba hibaválasza

Name	Típus	Description
code	string	Hibakód
message	string	A művelet sikertelen voltát jelző hibaüzenet.

Module

Objektum

A modultípus definíciója.

Name	Típus	Description
etag	string	Lekéri az erőforrás etagját.
id	string	Az erőforrás teljes erőforrás-azonosítója
location	string	Az Azure-régió, ahol az erőforrás él
name	string	Az erőforrás neve
properties.activityCount	integer (int32)	Lekéri a modul tevékenységszámát.
properties.contentLink	ContentLink	Lekéri vagy beállítja a modul contentLink elemét.
properties.creationTime	string (date-time)	Megkapja a létrehozási időt.
properties.description	string	Lekéri vagy beállítja a leírást.
properties.error	ModuleErrorInfo	Lekéri a modul hibainformációját.
properties.isComposite	boolean	Lekéri a modul típusát, ha összetett vagy nem.
properties.isGlobal	boolean	Lekéri a modul isGlobal jelölőjének értékét.
properties.lastModifiedTime	string (date-time)	Az utolsó módosítás időpontja.
properties.provisioningState	ModuleProvisioningState	Lekéri a modul kiépítési állapotát.
properties.sizeInBytes	integer (int64)	A modul méretét bájtban kapja meg.
properties.version	string	Lekéri a modul verzióját.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa.

ModuleErrorInfo

Objektum

A modul hibainformációs típusának meghatározása.

Name	Típus	Description
code	string	Lekéri a hibakódot.
message	string	Lekéri a hibaüzenetet.

ModuleProvisioningState

Enumerálás

Lekéri a modul kiépítési állapotát.

Érték	Description
ActivitiesStored
Canceled
ConnectionTypeImported
ContentDownloaded
ContentRetrieved
ContentStored
ContentValidated
Created
Creating
Failed
ModuleDataStored
ModuleImportRunbookComplete
RunningImportModuleRunbook
StartingImportModuleRunbook
Succeeded
Updating