Microsoft.Automation (stable:2024-10-23)

2024/12/09 • 172 new methods

AutomationAccount_Update (new)
Description Update an automation account.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName: string ,
automationAccountName: string ,
parameters:
{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
}
,
name: string ,
location: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
tags: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
lastModifiedBy: string ,
state: enum ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
automationHybridServiceUrl: string ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AutomationAccount_CreateOrUpdate (new)
Description Create or update automation account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName: string ,
automationAccountName: string ,
parameters:
{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
}
,
name: string ,
location: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
tags: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
lastModifiedBy: string ,
state: enum ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
automationHybridServiceUrl: string ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (201)

{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
lastModifiedBy: string ,
state: enum ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
automationHybridServiceUrl: string ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AutomationAccount_Delete (new)
Description Delete an automation account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
AutomationAccount_Get (new)
Description Get information about an Automation Account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
lastModifiedBy: string ,
state: enum ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
automationHybridServiceUrl: string ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AutomationAccount_ListByResourceGroup (new)
Description Retrieve a list of accounts within a given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts
{
resourceGroupName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
lastModifiedBy: string ,
state: enum ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
automationHybridServiceUrl: string ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AutomationAccount_List (new)
Description Retrieve a list of accounts within a given subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Automation/automationAccounts
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
sku:
{
name: enum ,
family: string ,
capacity: integer ,
}
,
lastModifiedBy: string ,
state: enum ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
encryption:
{
keyVaultProperties:
{
keyvaultUri: string ,
keyName: string ,
keyVersion: string ,
}
,
keySource: enum ,
identity:
{
userAssignedIdentity: object ,
}
,
}
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: string ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
publicNetworkAccess: boolean ,
disableLocalAuth: boolean ,
automationHybridServiceUrl: string ,
}
,
etag: string ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Statistics_ListByAutomationAccount (new)
Description Retrieve the statistics for the account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics
{
resourceGroupName: string ,
automationAccountName: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
counterProperty: string ,
counterValue: integer ,
startTime: string ,
endTime: string ,
id: string ,
}
,
]
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Usages_ListByAutomationAccount (new)
Description Retrieve the usage for the account id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
currentValue: number ,
limit: integer ,
throttleStatus: string ,
}
,
]
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Keys_ListByAutomationAccount (new)
Description Retrieve the automation keys for an account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
keys:
[
{
KeyName: enum ,
Permissions: enum ,
Value: string ,
}
,
]
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AutomationAccount_ListDeletedRunbooks (new)
Description Retrieve the deleted runbooks for an automation account.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listDeletedRunbooks
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
runbookId: string ,
runbookType: string ,
runtime: string ,
runtimeEnvironment: string ,
creationTime: string ,
deletionTime: string ,
}
,
id: string ,
name: string ,
location: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Certificate_Delete (new)
Description Delete the certificate.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName: string ,
automationAccountName: string ,
certificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
Certificate_Get (new)
Description Retrieve the certificate identified by certificate name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName: string ,
automationAccountName: string ,
certificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
thumbprint: string ,
expiryTime: string ,
isExportable: boolean ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Certificate_CreateOrUpdate (new)
Description Create a certificate.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName: string ,
automationAccountName: string ,
certificateName: string ,
parameters:
{
name: string ,
properties:
{
base64Value: string ,
description: string ,
thumbprint: string ,
isExportable: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
thumbprint: string ,
expiryTime: string ,
isExportable: boolean ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (200)

{
properties:
{
thumbprint: string ,
expiryTime: string ,
isExportable: boolean ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Certificate_Update (new)
Description Update a certificate.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName: string ,
automationAccountName: string ,
certificateName: string ,
parameters:
{
name: string ,
properties:
{
description: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
thumbprint: string ,
expiryTime: string ,
isExportable: boolean ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Certificate_ListByAutomationAccount (new)
Description Retrieve a list of certificates.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
thumbprint: string ,
expiryTime: string ,
isExportable: boolean ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Connection_Delete (new)
Description Delete the connection.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
Connection_Get (new)
Description Retrieve the connection identified by connection name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
connectionType:
{
name: string ,
}
,
fieldDefinitionValues: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Connection_CreateOrUpdate (new)
Description Create or update a connection.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionName: string ,
parameters:
{
name: string ,
properties:
{
description: string ,
connectionType:
{
name: string ,
}
,
fieldDefinitionValues: object ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
connectionType:
{
name: string ,
}
,
fieldDefinitionValues: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (200)

{
properties:
{
connectionType:
{
name: string ,
}
,
fieldDefinitionValues: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Connection_Update (new)
Description Update a connection.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionName: string ,
parameters:
{
name: string ,
properties:
{
description: string ,
fieldDefinitionValues: object ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
connectionType:
{
name: string ,
}
,
fieldDefinitionValues: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Connection_ListByAutomationAccount (new)
Description Retrieve a list of connections.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
connectionType:
{
name: string ,
}
,
fieldDefinitionValues: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
ConnectionType_Delete (new)
Description Delete the connection type.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionTypeName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
ConnectionType_Get (new)
Description Retrieve the connection type identified by connection type name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionTypeName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
properties:
{
isGlobal: boolean ,
fieldDefinitions: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
ConnectionType_CreateOrUpdate (new)
Description Create a connection type.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}
{
resourceGroupName: string ,
automationAccountName: string ,
connectionTypeName: string ,
parameters:
{
name: string ,
properties:
{
isGlobal: boolean ,
fieldDefinitions: object ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
id: string ,
name: string ,
type: string ,
properties:
{
isGlobal: boolean ,
fieldDefinitions: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
ConnectionType_ListByAutomationAccount (new)
Description Retrieve a list of connection types.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
properties:
{
isGlobal: boolean ,
fieldDefinitions: object ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Credential_Delete (new)
Description Delete the credential.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName: string ,
automationAccountName: string ,
credentialName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
Credential_Get (new)
Description Retrieve the credential identified by credential name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName: string ,
automationAccountName: string ,
credentialName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
userName: string ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Credential_CreateOrUpdate (new)
Description Create a credential.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName: string ,
automationAccountName: string ,
credentialName: string ,
parameters:
{
name: string ,
properties:
{
userName: string ,
password: string ,
description: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
userName: string ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (200)

{
properties:
{
userName: string ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Credential_Update (new)
Description Update a credential.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName: string ,
automationAccountName: string ,
credentialName: string ,
parameters:
{
name: string ,
properties:
{
userName: string ,
password: string ,
description: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
userName: string ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
Credential_ListByAutomationAccount (new)
Description Retrieve a list of credentials.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
userName: string ,
creationTime: string ,
lastModifiedTime: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}
deletedAutomationAccounts_ListBySubscription (new)
Description Retrieve deleted automation account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Automation/deletedAutomationAccounts
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
automationAccountResourceId: string ,
automationAccountId: string ,
location: string ,
deletionTime: string ,
}
,
id: string ,
name: string ,
type: string ,
location: string ,
}
,
]
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscConfiguration_Delete (new)
Description Delete the dsc configuration identified by configuration name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName: string ,
automationAccountName: string ,
configurationName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscConfiguration_Get (new)
Description Retrieve the configuration identified by configuration name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName: string ,
automationAccountName: string ,
configurationName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
jobCount: integer ,
parameters: object ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
state: enum ,
logVerbose: boolean ,
creationTime: string ,
lastModifiedTime: string ,
nodeConfigurationCount: integer ,
description: string ,
}
,
etag: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscConfiguration_CreateOrUpdate (new)
Description Create the configuration identified by configuration name.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName: string ,
automationAccountName: string ,
configurationName: string ,
parameters:
{
properties:
{
logVerbose: boolean ,
logProgress: boolean ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
parameters: object ,
description: string ,
}
,
name: string ,
location: string ,
tags: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
jobCount: integer ,
parameters: object ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
state: enum ,
logVerbose: boolean ,
creationTime: string ,
lastModifiedTime: string ,
nodeConfigurationCount: integer ,
description: string ,
}
,
etag: string ,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
jobCount: integer ,
parameters: object ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
state: enum ,
logVerbose: boolean ,
creationTime: string ,
lastModifiedTime: string ,
nodeConfigurationCount: integer ,
description: string ,
}
,
etag: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscConfiguration_Update (new)
Description Create the configuration identified by configuration name.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName: string ,
automationAccountName: string ,
configurationName: string ,
parameters:
{
properties:
{
logVerbose: boolean ,
logProgress: boolean ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
parameters: object ,
description: string ,
}
,
name: string ,
tags: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
jobCount: integer ,
parameters: object ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
state: enum ,
logVerbose: boolean ,
creationTime: string ,
lastModifiedTime: string ,
nodeConfigurationCount: integer ,
description: string ,
}
,
etag: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscConfiguration_GetContent (new)
Description Retrieve the configuration script identified by configuration name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content
{
resourceGroupName: string ,
automationAccountName: string ,
configurationName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscConfiguration_ListByAutomationAccount (new)
Description Retrieve a list of configurations.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations
{
resourceGroupName: string ,
automationAccountName: string ,
subscriptionId: string ,
api-version: string ,
$filter: string ,
$skip: integer ,
$top: integer ,
$inlinecount: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
jobCount: integer ,
parameters: object ,
source:
{
hash:
{
algorithm: string ,
value: string ,
}
,
type: enum ,
value: string ,
version: string ,
}
,
state: enum ,
logVerbose: boolean ,
creationTime: string ,
lastModifiedTime: string ,
nodeConfigurationCount: integer ,
description: string ,
}
,
etag: string ,
}
,
]
,
nextLink: string ,
totalCount: integer ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AgentRegistrationInformation_Get (new)
Description Retrieve the automation agent registration information.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation
{
subscriptionId: string ,
resourceGroupName: string ,
automationAccountName: string ,
api-version: string ,
}

⚐ Response (200)

{
dscMetaConfiguration: string ,
endpoint: string ,
keys:
{
primary: string ,
secondary: string ,
}
,
id: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
AgentRegistrationInformation_RegenerateKey (new)
Description Regenerate a primary or secondary agent registration key
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey
{
subscriptionId: string ,
resourceGroupName: string ,
automationAccountName: string ,
parameters:
{
keyName: enum ,
}
,
api-version: string ,
}

⚐ Response (200)

{
dscMetaConfiguration: string ,
endpoint: string ,
keys:
{
primary: string ,
secondary: string ,
}
,
id: string ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscNode_Delete (new)
Description Delete the dsc node identified by node id.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
{
resourceGroupName: string ,
automationAccountName: string ,
nodeId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscNode_Get (new)
Description Retrieve the dsc node identified by node id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
{
resourceGroupName: string ,
automationAccountName: string ,
nodeId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
lastSeen: string ,
registrationTime: string ,
ip: string ,
accountId: string ,
nodeConfiguration:
{
name: string ,
}
,
status: string ,
nodeId: string ,
etag: string ,
totalCount: integer ,
extensionHandler:
[
{
name: string ,
version: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscNode_Update (new)
Description Update the dsc node.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
{
resourceGroupName: string ,
automationAccountName: string ,
nodeId: string ,
dscNodeUpdateParameters:
{
nodeId: string ,
properties:
{
nodeConfiguration:
{
name: string ,
}
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
lastSeen: string ,
registrationTime: string ,
ip: string ,
accountId: string ,
nodeConfiguration:
{
name: string ,
}
,
status: string ,
nodeId: string ,
etag: string ,
totalCount: integer ,
extensionHandler:
[
{
name: string ,
version: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
DscNode_ListByAutomationAccount (new)
Description Retrieve a list of dsc nodes.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes
{
resourceGroupName: string ,
automationAccountName: string ,
$filter: string ,
$skip: integer ,
$top: integer ,
$inlinecount: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
lastSeen: string ,
registrationTime: string ,
ip: string ,
accountId: string ,
nodeConfiguration:
{
name: string ,
}
,
status: string ,
nodeId: string ,
etag: string ,
totalCount: integer ,
extensionHandler:
[
{
name: string ,
version: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
totalCount: integer ,
}

⚐ Response (default)

{
code: string ,
message: string ,
}
NodeReports_ListByNode (new)
Description Retrieve the Dsc node report list by node id.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports
{
resourceGroupName: string ,
automationAccountName: string ,
nodeId: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
endTime: string ,
lastModifiedTime: string ,
startTime: string ,
type: string ,
reportId: string ,
status: