Automation Account - Update

Dienst:: Automation

API-Version:: 2023-11-01

Aktualisieren eines Automatisierungskontos.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automatisierungskontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Name einer Azure-Ressourcengruppe.
subscriptionId	path	True	string	Ruft Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
identity	Identity	Legt die Identitätseigenschaft für das Automatisierungskonto fest.
location	string	Dient zum Abrufen oder Festlegen des Speicherorts der Ressource.
name	string	Dient zum Abrufen oder Festlegen des Namens der Ressource.
properties.disableLocalAuth	boolean	Gibt an, ob Anforderungen, die keine AAD-Authentifizierung verwenden, blockiert werden
properties.encryption	EncryptionProperties	Festlegen der Verschlüsselungseigenschaften für das Automatisierungskonto
properties.publicNetworkAccess	boolean	Gibt an, ob Datenverkehr auf dem Nicht-ARM-Endpunkt (Webhook/Agent) aus dem öffentlichen Internet zulässig ist.
properties.sku	Sku	Ruft die Konto-SKU ab oder legt sie fest.
tags	object	Ruft die tags ab, die der Ressource zugeordnet sind, oder legt sie fest.

Antworten

Name	Typ	Beschreibung
200 OK	AutomationAccount	OKAY
Other Status Codes	ErrorResponse	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Update an automation account

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9?api-version=2023-11-01

{
  "properties": {
    "sku": {
      "name": "Free"
    }
  },
  "name": "myAutomationAccount9",
  "location": "East US 2"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "myAutomationAccount9",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9",
  "type": "Microsoft.Automation/AutomationAccounts",
  "location": "East US 2",
  "tags": {},
  "etag": null,
  "properties": {
    "sku": {
      "name": "Free",
      "family": null,
      "capacity": null
    },
    "state": "Ok",
    "creationTime": "2017-03-26T01:13:43.267+00:00",
    "lastModifiedBy": "myEmailId@microsoft.com",
    "lastModifiedTime": "2017-03-26T01:13:43.267+00:00"
  }
}

Definitionen

Name	Beschreibung
AutomationAccount	Definition des Automatisierungskontotyps.
AutomationAccountState	Ruft den Status des Kontos ab.
AutomationAccountUpdateParameters	Die Parameter, die für den Updateautomatisierungs-Kontovorgang bereitgestellt werden.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EncryptionKeySourceType	Verschlüsselungsschlüsselquelle
EncryptionProperties	Die Verschlüsselungseinstellungen für das Automatisierungskonto
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
Identity	Identität für die Ressource.
KeyVaultProperties	Einstellungen für die Schlüsseltresorverschlüsselung für einen Konfigurationsspeicher.
PrivateEndpointConnection	Eine private Endpunktverbindung
PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der privaten Endpunktverbindung.
ResourceIdentityType	Der Identitätstyp.
Sku	Die Konto-SKU.
SkuNameEnum	Dient zum Abrufen oder Festlegen des SKU-Namens des Kontos.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentitiesProperties

AutomationAccount

Objekt

Definition des Automatisierungskontotyps.

Name	Typ	Beschreibung
etag	string	Dient zum Abrufen oder Festlegen des Etags der Ressource.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource
identity	Identity	Identität für die Ressource.
location	string	Die Azure-Region, in der sich die Ressource befindet
name	string	Der Name der Ressource
properties.automationHybridServiceUrl	string	URL des Automatisierungshybriddiensts, der für hybride Mitarbeiter beim Onboarding verwendet wird.
properties.creationTime	string (date-time)	Ruft die Erstellungszeit ab.
properties.description	string	Ruft die Beschreibung ab oder legt sie fest.
properties.disableLocalAuth	boolean	Gibt an, ob Anforderungen, die keine AAD-Authentifizierung verwenden, blockiert werden
properties.encryption	EncryptionProperties	Verschlüsselungseigenschaften für das Automatisierungskonto
properties.lastModifiedBy	string	Ruft die letzte Änderung ab oder legt sie fest.
properties.lastModifiedTime	string (date-time)	Ruft den Zeitpunkt der letzten Änderung ab.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste der Automatisierungsvorgänge, die vom Automatisierungsressourcenanbieter unterstützt werden.
properties.publicNetworkAccess	boolean	Gibt an, ob Datenverkehr auf dem Nicht-ARM-Endpunkt (Webhook/Agent) aus dem öffentlichen Internet zulässig ist.
properties.sku	Sku	Ruft die SKU des Kontos ab oder legt sie fest.
properties.state	AutomationAccountState	Ruft den Status des Kontos ab.
systemData	systemData	Ressourcensystemmetadaten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource.

AutomationAccountState

Enumeration

Ruft den Status des Kontos ab.

Wert	Beschreibung
Ok
Suspended
Unavailable

AutomationAccountUpdateParameters

Objekt

Die Parameter, die für den Updateautomatisierungs-Kontovorgang bereitgestellt werden.

Name	Typ	Beschreibung
identity	Identity	Legt die Identitätseigenschaft für das Automatisierungskonto fest.
location	string	Dient zum Abrufen oder Festlegen des Speicherorts der Ressource.
name	string	Dient zum Abrufen oder Festlegen des Namens der Ressource.
properties.disableLocalAuth	boolean	Gibt an, ob Anforderungen, die keine AAD-Authentifizierung verwenden, blockiert werden
properties.encryption	EncryptionProperties	Festlegen der Verschlüsselungseigenschaften für das Automatisierungskonto
properties.publicNetworkAccess	boolean	Gibt an, ob Datenverkehr auf dem Nicht-ARM-Endpunkt (Webhook/Agent) aus dem öffentlichen Internet zulässig ist.
properties.sku	Sku	Ruft die Konto-SKU ab oder legt sie fest.
tags	object	Ruft die tags ab, die der Ressource zugeordnet sind, oder legt sie fest.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EncryptionKeySourceType

Enumeration

Verschlüsselungsschlüsselquelle

Wert	Beschreibung
Microsoft.Automation
Microsoft.Keyvault

EncryptionProperties

Objekt

Die Verschlüsselungseinstellungen für das Automatisierungskonto

Name	Typ	Beschreibung
identity	Identity	Für CMK verwendete Benutzeridentität.
keySource	EncryptionKeySourceType	Verschlüsselungsschlüsselquelle
keyVaultProperties	KeyVaultProperties	Schlüsseltresoreigenschaften.

ErrorResponse

Objekt

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Identity

Objekt

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität.
tenantId	string	Die Mandanten-ID der Ressource.
type	ResourceIdentityType	Der Identitätstyp.
userAssignedIdentities	<string, UserAssignedIdentitiesProperties>	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

KeyVaultProperties

Objekt

Einstellungen für die Schlüsseltresorverschlüsselung für einen Konfigurationsspeicher.

Name	Typ	Beschreibung
keyName	string	Der Name des Schlüssels, der zum Verschlüsseln von Daten verwendet wird.
keyVersion	string	Die Schlüsselversion des Schlüssels, der zum Verschlüsseln von Daten verwendet wird.
keyvaultUri	string	Der URI des Schlüsseltresorschlüssels, der zum Verschlüsseln von Daten verwendet wird.

PrivateEndpointConnection

Objekt

Eine private Endpunktverbindung

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource
name	string	Der Name der Ressource
properties.groupIds	string[]	Ruft die groupIds ab.
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der privaten Endpunktverbindung.
type	string	Der Typ der Ressource.

PrivateEndpointProperty

Objekt

Privater Endpunkt, zu dem die Verbindung gehört.

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateLinkServiceConnectionStateProperty

Objekt

Verbindungsstatus der privaten Endpunktverbindung.

Name	Typ	Beschreibung
actionsRequired	string	Jede Aktion, die über den grundlegenden Workflow hinaus erforderlich ist (genehmigen/ ablehnen/trennen)
description	string	Die Verbindungsbeschreibung des privaten Linksdiensts.
status	string	Der Verbindungsstatus des privaten Verknüpfungsdiensts.

ResourceIdentityType

Enumeration

Der Identitätstyp.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Sku

Objekt

Die Konto-SKU.

Name	Typ	Beschreibung
capacity	integer (int32)	Ruft die SKU-Kapazität ab oder legt sie fest.
family	string	Ruft die SKU-Familie ab oder legt sie fest.
name	SkuNameEnum	Dient zum Abrufen oder Festlegen des SKU-Namens des Kontos.

SkuNameEnum

Enumeration

Dient zum Abrufen oder Festlegen des SKU-Namens des Kontos.

Wert	Beschreibung
Basic
Free

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentitiesProperties

Objekt

Name	Typ	Beschreibung
clientId	string	Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

Freigeben über

Automation Account - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Update an automation account

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AutomationAccount

AutomationAccountState

AutomationAccountUpdateParameters

createdByType

EncryptionKeySourceType

EncryptionProperties

ErrorResponse

Identity

KeyVaultProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

ResourceIdentityType

Sku

SkuNameEnum

systemData

UserAssignedIdentitiesProperties