armautomation

package module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2022 License: MIT Imports: 19 Imported by: 20

README

Azure Automation Module for Go

PkgGoDev

The armautomation module provides operations for working with Azure Automation.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Automation module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Automation. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Automation modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armautomation.NewHybridRunbookWorkerGroupClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armautomation.NewHybridRunbookWorkerGroupClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Automation label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account added in v0.3.0 

type Account struct {
	// Gets or sets the etag of the resource.
	Etag *string `json:"etag,omitempty"`

	// Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`

	// The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`

	// Gets or sets the automation account properties.
	Properties *AccountProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource system metadata.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Account - Definition of the automation account type.

func (Account) MarshalJSON added in v0.3.0 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Account.

type AccountClient added in v0.3.0 

type AccountClient struct {
	// contains filtered or unexported fields
}

AccountClient contains the methods for the AutomationAccount group. Don't use this type directly, use NewAccountClient() instead.

func NewAccountClient added in v0.3.0 

func NewAccountClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccountClient, error)

NewAccountClient creates a new instance of AccountClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccountClient) CreateOrUpdate added in v0.3.0 

func (client *AccountClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, parameters AccountCreateOrUpdateParameters, options *AccountClientCreateOrUpdateOptions) (AccountClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update automation account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. parameters - Parameters supplied to the create or update automation account. options - AccountClientCreateOrUpdateOptions contains the optional parameters for the AccountClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/createOrUpdateAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAccountClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount9",
		armautomation.AccountCreateOrUpdateParameters{
			Name:     to.Ptr("myAutomationAccount9"),
			Location: to.Ptr("East US 2"),
			Properties: &armautomation.AccountCreateOrUpdateProperties{
				SKU: &armautomation.SKU{
					Name: to.Ptr(armautomation.SKUNameEnumFree),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AccountClient) Delete added in v0.3.0 

func (client *AccountClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, options *AccountClientDeleteOptions) (AccountClientDeleteResponse, error)

Delete - Delete an automation account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - AccountClientDeleteOptions contains the optional parameters for the AccountClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/deleteAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAccountClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount9",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*AccountClient) Get added in v0.3.0 

func (client *AccountClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, options *AccountClientGetOptions) (AccountClientGetResponse, error)

Get - Get information about an Automation Account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - AccountClientGetOptions contains the optional parameters for the AccountClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAccountClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount9",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AccountClient) NewListByResourceGroupPager added in v0.5.0 

func (client *AccountClient) NewListByResourceGroupPager(resourceGroupName string, options *AccountClientListByResourceGroupOptions) *runtime.Pager[AccountClientListByResourceGroupResponse]

NewListByResourceGroupPager - Retrieve a list of accounts within a given resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. options - AccountClientListByResourceGroupOptions contains the optional parameters for the AccountClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/listAutomationAccountsByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAccountClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("rg",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*AccountClient) NewListPager added in v0.5.0 

func (client *AccountClient) NewListPager(options *AccountClientListOptions) *runtime.Pager[AccountClientListResponse]

NewListPager - Retrieve a list of accounts within a given subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 options - AccountClientListOptions contains the optional parameters for the AccountClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/listAutomationAccountsBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAccountClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*AccountClient) Update added in v0.3.0 

func (client *AccountClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, parameters AccountUpdateParameters, options *AccountClientUpdateOptions) (AccountClientUpdateResponse, error)

Update - Update an automation account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. parameters - Parameters supplied to the update automation account. options - AccountClientUpdateOptions contains the optional parameters for the AccountClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/updateAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAccountClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount9",
		armautomation.AccountUpdateParameters{
			Name:     to.Ptr("myAutomationAccount9"),
			Location: to.Ptr("East US 2"),
			Properties: &armautomation.AccountUpdateProperties{
				SKU: &armautomation.SKU{
					Name: to.Ptr(armautomation.SKUNameEnumFree),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type AccountClientCreateOrUpdateOptions added in v0.3.0 

type AccountClientCreateOrUpdateOptions struct {
}

AccountClientCreateOrUpdateOptions contains the optional parameters for the AccountClient.CreateOrUpdate method.

type AccountClientCreateOrUpdateResponse added in v0.3.0 

type AccountClientCreateOrUpdateResponse struct {
	Account
}

AccountClientCreateOrUpdateResponse contains the response from method AccountClient.CreateOrUpdate.

type AccountClientDeleteOptions added in v0.3.0 

type AccountClientDeleteOptions struct {
}

AccountClientDeleteOptions contains the optional parameters for the AccountClient.Delete method.

type AccountClientDeleteResponse added in v0.3.0 

type AccountClientDeleteResponse struct {
}

AccountClientDeleteResponse contains the response from method AccountClient.Delete.

type AccountClientGetOptions added in v0.3.0 

type AccountClientGetOptions struct {
}

AccountClientGetOptions contains the optional parameters for the AccountClient.Get method.

type AccountClientGetResponse added in v0.3.0 

type AccountClientGetResponse struct {
	Account
}

AccountClientGetResponse contains the response from method AccountClient.Get.

type AccountClientListByResourceGroupOptions added in v0.3.0 

type AccountClientListByResourceGroupOptions struct {
}

AccountClientListByResourceGroupOptions contains the optional parameters for the AccountClient.ListByResourceGroup method.

type AccountClientListByResourceGroupResponse added in v0.3.0 

type AccountClientListByResourceGroupResponse struct {
	AccountListResult
}

AccountClientListByResourceGroupResponse contains the response from method AccountClient.ListByResourceGroup.

type AccountClientListOptions added in v0.3.0 

type AccountClientListOptions struct {
}

AccountClientListOptions contains the optional parameters for the AccountClient.List method.

type AccountClientListResponse added in v0.3.0 

type AccountClientListResponse struct {
	AccountListResult
}

AccountClientListResponse contains the response from method AccountClient.List.

type AccountClientUpdateOptions added in v0.3.0 

type AccountClientUpdateOptions struct {
}

AccountClientUpdateOptions contains the optional parameters for the AccountClient.Update method.

type AccountClientUpdateResponse added in v0.3.0 

type AccountClientUpdateResponse struct {
	Account
}

AccountClientUpdateResponse contains the response from method AccountClient.Update.

type AccountCreateOrUpdateParameters added in v0.3.0 

type AccountCreateOrUpdateParameters struct {
	// Sets the identity property for automation account
	Identity *Identity `json:"identity,omitempty"`

	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets account create or update properties.
	Properties *AccountCreateOrUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

AccountCreateOrUpdateParameters - The parameters supplied to the create or update automation account operation.

func (AccountCreateOrUpdateParameters) MarshalJSON added in v0.3.0 

func (a AccountCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountCreateOrUpdateParameters.

type AccountCreateOrUpdateProperties added in v0.3.0 

type AccountCreateOrUpdateProperties struct {
	// Indicates whether requests using non-AAD authentication are blocked
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Set the encryption properties for the automation account
	Encryption *EncryptionProperties `json:"encryption,omitempty"`

	// Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
	PublicNetworkAccess *bool `json:"publicNetworkAccess,omitempty"`

	// Gets or sets account SKU.
	SKU *SKU `json:"sku,omitempty"`
}

AccountCreateOrUpdateProperties - The parameters supplied to the create or update account properties.

type AccountListResult added in v0.3.0 

type AccountListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets list of accounts.
	Value []*Account `json:"value,omitempty"`
}

AccountListResult - The response model for the list account operation.

type AccountProperties added in v0.3.0 

type AccountProperties struct {
	// URL of automation hybrid service which is used for hybrid worker on-boarding.
	AutomationHybridServiceURL *string `json:"automationHybridServiceUrl,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Indicates whether requests using non-AAD authentication are blocked
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Encryption properties for the automation account
	Encryption *EncryptionProperties `json:"encryption,omitempty"`

	// Gets or sets the last modified by.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// List of Automation operations supported by the Automation resource provider.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`

	// Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
	PublicNetworkAccess *bool `json:"publicNetworkAccess,omitempty"`

	// Gets or sets the SKU of account.
	SKU *SKU `json:"sku,omitempty"`

	// READ-ONLY; Gets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets status of account.
	State *AutomationAccountState `json:"state,omitempty" azure:"ro"`
}

AccountProperties - Definition of the account property.

func (AccountProperties) MarshalJSON added in v0.3.0 

func (a AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountProperties.

func (*AccountProperties) UnmarshalJSON added in v0.3.0 

func (a *AccountProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountProperties.

type AccountUpdateParameters added in v0.3.0 

type AccountUpdateParameters struct {
	// Sets the identity property for automation account
	Identity *Identity `json:"identity,omitempty"`

	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets the name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets account update properties.
	Properties *AccountUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

AccountUpdateParameters - The parameters supplied to the update automation account operation.

func (AccountUpdateParameters) MarshalJSON added in v0.3.0 

func (a AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountUpdateParameters.

type AccountUpdateProperties added in v0.3.0 

type AccountUpdateProperties struct {
	// Indicates whether requests using non-AAD authentication are blocked
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Set the encryption properties for the automation account
	Encryption *EncryptionProperties `json:"encryption,omitempty"`

	// Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
	PublicNetworkAccess *bool `json:"publicNetworkAccess,omitempty"`

	// Gets or sets account SKU.
	SKU *SKU `json:"sku,omitempty"`
}

AccountUpdateProperties - The parameters supplied to the update account properties.

type Activity 

type Activity struct {
	// Gets or sets the id of the resource.
	ID *string `json:"id,omitempty"`

	// Gets or sets the properties of the activity.
	Properties *ActivityProperties `json:"properties,omitempty"`

	// READ-ONLY; Gets the name of the activity.
	Name *string `json:"name,omitempty" azure:"ro"`
}

Activity - Definition of the activity.

type ActivityClient 

type ActivityClient struct {
	// contains filtered or unexported fields
}

ActivityClient contains the methods for the Activity group. Don't use this type directly, use NewActivityClient() instead.

func NewActivityClient 

func NewActivityClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ActivityClient, error)

NewActivityClient creates a new instance of ActivityClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ActivityClient) Get 

func (client *ActivityClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, activityName string, options *ActivityClientGetOptions) (ActivityClientGetResponse, error)

Get - Retrieve the activity in the module identified by module name and activity name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The name of module. activityName - The name of activity. options - ActivityClientGetOptions contains the optional parameters for the ActivityClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getActivityInAModule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewActivityClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		"Add-AzureRmAccount",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ActivityClient) NewListByModulePager added in v0.5.0 

func (client *ActivityClient) NewListByModulePager(resourceGroupName string, automationAccountName string, moduleName string, options *ActivityClientListByModuleOptions) *runtime.Pager[ActivityClientListByModuleResponse]

NewListByModulePager - Retrieve a list of activities in the module identified by module name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The name of module. options - ActivityClientListByModuleOptions contains the optional parameters for the ActivityClient.ListByModule method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listActivitiesByModule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewActivityClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByModulePager("rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ActivityClientGetOptions added in v0.3.0 

type ActivityClientGetOptions struct {
}

ActivityClientGetOptions contains the optional parameters for the ActivityClient.Get method.

type ActivityClientGetResponse added in v0.3.0 

type ActivityClientGetResponse struct {
	Activity
}

ActivityClientGetResponse contains the response from method ActivityClient.Get.

type ActivityClientListByModuleOptions added in v0.3.0 

type ActivityClientListByModuleOptions struct {
}

ActivityClientListByModuleOptions contains the optional parameters for the ActivityClient.ListByModule method.

type ActivityClientListByModuleResponse added in v0.3.0 

type ActivityClientListByModuleResponse struct {
	ActivityListResult
}

ActivityClientListByModuleResponse contains the response from method ActivityClient.ListByModule.

type ActivityListResult 

type ActivityListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of activities.
	Value []*Activity `json:"value,omitempty"`
}

ActivityListResult - The response model for the list activity operation.

type ActivityOutputType 

type ActivityOutputType struct {
	// Gets or sets the name of the activity output type.
	Name *string `json:"name,omitempty"`

	// Gets or sets the type of the activity output type.
	Type *string `json:"type,omitempty"`
}

ActivityOutputType - Definition of the activity output type.

type ActivityParameter 

type ActivityParameter struct {
	// Gets or sets the description of the activity parameter.
	Description *string `json:"description,omitempty"`

	// Gets or sets a Boolean value that indicates true if the parameter is dynamic.
	IsDynamic *bool `json:"isDynamic,omitempty"`

	// Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is
	// optional.
	IsMandatory *bool `json:"isMandatory,omitempty"`

	// Gets or sets the name of the activity parameter.
	Name *string `json:"name,omitempty"`

	// Gets or sets the position of the activity parameter.
	Position *int64 `json:"position,omitempty"`

	// Gets or sets the type of the activity parameter.
	Type *string `json:"type,omitempty"`

	// Gets or sets the validation set of activity parameter.
	ValidationSet []*ActivityParameterValidationSet `json:"validationSet,omitempty"`

	// Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This
	// setting is used if the cmdlet must access the complete input object. false
	// indicates that the parameter cannot take values from the complete input object.
	ValueFromPipeline *bool `json:"valueFromPipeline,omitempty"`

	// Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline
	// object that has the same name as this parameter. false indicates that the
	// parameter cannot be filled from the incoming pipeline object property with the same name.
	ValueFromPipelineByPropertyName *bool `json:"valueFromPipelineByPropertyName,omitempty"`

	// Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments
	// that are associated with this parameter in the form of an array. false if the
	// cmdlet parameter does not accept all the remaining argument values.
	ValueFromRemainingArguments *bool `json:"valueFromRemainingArguments,omitempty"`
}

ActivityParameter - Definition of the activity parameter.

type ActivityParameterSet 

type ActivityParameterSet struct {
	// Gets or sets the name of the activity parameter set.
	Name *string `json:"name,omitempty"`

	// Gets or sets the parameters of the activity parameter set.
	Parameters []*ActivityParameter `json:"parameters,omitempty"`
}

ActivityParameterSet - Definition of the activity parameter set.

type ActivityParameterValidationSet 

type ActivityParameterValidationSet struct {
	// Gets or sets the name of the activity parameter validation set member.
	MemberValue *string `json:"memberValue,omitempty"`
}

ActivityParameterValidationSet - Definition of the activity parameter validation set.

type ActivityProperties 

type ActivityProperties struct {
	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the user name of the activity.
	Definition *string `json:"definition,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the output types of the activity.
	OutputTypes []*ActivityOutputType `json:"outputTypes,omitempty"`

	// Gets or sets the parameter sets of the activity.
	ParameterSets []*ActivityParameterSet `json:"parameterSets,omitempty"`
}

ActivityProperties - Properties of the activity.

func (*ActivityProperties) UnmarshalJSON 

func (a *ActivityProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ActivityProperties.

type AdvancedSchedule 

type AdvancedSchedule struct {
	// Days of the month that the job should execute on. Must be between 1 and 31.
	MonthDays []*int32 `json:"monthDays,omitempty"`

	// Occurrences of days within a month.
	MonthlyOccurrences []*AdvancedScheduleMonthlyOccurrence `json:"monthlyOccurrences,omitempty"`

	// Days of the week that the job should execute on.
	WeekDays []*string `json:"weekDays,omitempty"`
}

AdvancedSchedule - The properties of the create Advanced Schedule.

func (AdvancedSchedule) MarshalJSON 

func (a AdvancedSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AdvancedSchedule.

type AdvancedScheduleMonthlyOccurrence 

type AdvancedScheduleMonthlyOccurrence struct {
	// Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
	Day *ScheduleDay `json:"day,omitempty"`

	// Occurrence of the week within the month. Must be between 1 and 5
	Occurrence *int32 `json:"occurrence,omitempty"`
}

AdvancedScheduleMonthlyOccurrence - The properties of the create advanced schedule monthly occurrence.

type AgentRegistration 

type AgentRegistration struct {
	// Gets or sets the dsc meta configuration.
	DscMetaConfiguration *string `json:"dscMetaConfiguration,omitempty"`

	// Gets or sets the dsc server endpoint.
	Endpoint *string `json:"endpoint,omitempty"`

	// Gets or sets the id.
	ID *string `json:"id,omitempty"`

	// Gets or sets the agent registration keys.
	Keys *AgentRegistrationKeys `json:"keys,omitempty"`
}

AgentRegistration - Definition of the agent registration information type.

type AgentRegistrationInformationClient 

type AgentRegistrationInformationClient struct {
	// contains filtered or unexported fields
}

AgentRegistrationInformationClient contains the methods for the AgentRegistrationInformation group. Don't use this type directly, use NewAgentRegistrationInformationClient() instead.

func NewAgentRegistrationInformationClient 

func NewAgentRegistrationInformationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AgentRegistrationInformationClient, error)

NewAgentRegistrationInformationClient creates a new instance of AgentRegistrationInformationClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AgentRegistrationInformationClient) Get 

func (client *AgentRegistrationInformationClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, options *AgentRegistrationInformationClientGetOptions) (AgentRegistrationInformationClientGetResponse, error)

Get - Retrieve the automation agent registration information. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - AgentRegistrationInformationClientGetOptions contains the optional parameters for the AgentRegistrationInformationClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getAgentRegistration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAgentRegistrationInformationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount18",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*AgentRegistrationInformationClient) RegenerateKey 

func (client *AgentRegistrationInformationClient) RegenerateKey(ctx context.Context, resourceGroupName string, automationAccountName string, parameters AgentRegistrationRegenerateKeyParameter, options *AgentRegistrationInformationClientRegenerateKeyOptions) (AgentRegistrationInformationClientRegenerateKeyResponse, error)

RegenerateKey - Regenerate a primary or secondary agent registration key If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. parameters - The name of the agent registration key to be regenerated options - AgentRegistrationInformationClientRegenerateKeyOptions contains the optional parameters for the AgentRegistrationInformationClient.RegenerateKey method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/regenerateAgentRegistrationKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewAgentRegistrationInformationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.RegenerateKey(ctx,
		"rg",
		"myAutomationAccount18",
		armautomation.AgentRegistrationRegenerateKeyParameter{
			KeyName: to.Ptr(armautomation.AgentRegistrationKeyNamePrimary),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type AgentRegistrationInformationClientGetOptions added in v0.3.0 

type AgentRegistrationInformationClientGetOptions struct {
}

AgentRegistrationInformationClientGetOptions contains the optional parameters for the AgentRegistrationInformationClient.Get method.

type AgentRegistrationInformationClientGetResponse added in v0.3.0 

type AgentRegistrationInformationClientGetResponse struct {
	AgentRegistration
}

AgentRegistrationInformationClientGetResponse contains the response from method AgentRegistrationInformationClient.Get.

type AgentRegistrationInformationClientRegenerateKeyOptions added in v0.3.0 

type AgentRegistrationInformationClientRegenerateKeyOptions struct {
}

AgentRegistrationInformationClientRegenerateKeyOptions contains the optional parameters for the AgentRegistrationInformationClient.RegenerateKey method.

type AgentRegistrationInformationClientRegenerateKeyResponse added in v0.3.0 

type AgentRegistrationInformationClientRegenerateKeyResponse struct {
	AgentRegistration
}

AgentRegistrationInformationClientRegenerateKeyResponse contains the response from method AgentRegistrationInformationClient.RegenerateKey.

type AgentRegistrationKeyName 

type AgentRegistrationKeyName string

AgentRegistrationKeyName - Gets or sets the agent registration key name - primary or secondary. 

const (
	AgentRegistrationKeyNamePrimary   AgentRegistrationKeyName = "primary"
	AgentRegistrationKeyNameSecondary AgentRegistrationKeyName = "secondary"
)

func PossibleAgentRegistrationKeyNameValues 

func PossibleAgentRegistrationKeyNameValues() []AgentRegistrationKeyName

PossibleAgentRegistrationKeyNameValues returns the possible values for the AgentRegistrationKeyName const type.

type AgentRegistrationKeys 

type AgentRegistrationKeys struct {
	// Gets or sets the primary key.
	Primary *string `json:"primary,omitempty"`

	// Gets or sets the secondary key.
	Secondary *string `json:"secondary,omitempty"`
}

AgentRegistrationKeys - Definition of the agent registration keys.

type AgentRegistrationRegenerateKeyParameter 

type AgentRegistrationRegenerateKeyParameter struct {
	// REQUIRED; Gets or sets the agent registration key name - primary or secondary.
	KeyName *AgentRegistrationKeyName `json:"keyName,omitempty"`
}

AgentRegistrationRegenerateKeyParameter - The parameters supplied to the regenerate keys operation.

type AutomationAccountState 

type AutomationAccountState string

AutomationAccountState - Gets status of account. 

const (
	AutomationAccountStateOk          AutomationAccountState = "Ok"
	AutomationAccountStateSuspended   AutomationAccountState = "Suspended"
	AutomationAccountStateUnavailable AutomationAccountState = "Unavailable"
)

func PossibleAutomationAccountStateValues 

func PossibleAutomationAccountStateValues() []AutomationAccountState

PossibleAutomationAccountStateValues returns the possible values for the AutomationAccountState const type.

type AutomationKeyName 

type AutomationKeyName string

AutomationKeyName - Automation key name. 

const (
	AutomationKeyNamePrimary   AutomationKeyName = "Primary"
	AutomationKeyNameSecondary AutomationKeyName = "Secondary"
)

func PossibleAutomationKeyNameValues 

func PossibleAutomationKeyNameValues() []AutomationKeyName

PossibleAutomationKeyNameValues returns the possible values for the AutomationKeyName const type.

type AutomationKeyPermissions 

type AutomationKeyPermissions string

AutomationKeyPermissions - Automation key permissions. 

const (
	AutomationKeyPermissionsFull AutomationKeyPermissions = "Full"
	AutomationKeyPermissionsRead AutomationKeyPermissions = "Read"
)

func PossibleAutomationKeyPermissionsValues 

func PossibleAutomationKeyPermissionsValues() []AutomationKeyPermissions

PossibleAutomationKeyPermissionsValues returns the possible values for the AutomationKeyPermissions const type.

type AzureQueryProperties 

type AzureQueryProperties struct {
	// List of locations to scope the query to.
	Locations []*string `json:"locations,omitempty"`

	// List of Subscription or Resource Group ARM Ids.
	Scope []*string `json:"scope,omitempty"`

	// Tag settings for the VM.
	TagSettings *TagSettingsProperties `json:"tagSettings,omitempty"`
}

AzureQueryProperties - Azure query for the update configuration.

func (AzureQueryProperties) MarshalJSON 

func (a AzureQueryProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureQueryProperties.

type Certificate 

type Certificate struct {
	// Gets or sets the properties of the certificate.
	Properties *CertificateProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Certificate - Definition of the certificate.

type CertificateClient 

type CertificateClient struct {
	// contains filtered or unexported fields
}

CertificateClient contains the methods for the Certificate group. Don't use this type directly, use NewCertificateClient() instead.

func NewCertificateClient 

func NewCertificateClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CertificateClient, error)

NewCertificateClient creates a new instance of CertificateClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CertificateClient) CreateOrUpdate 

func (client *CertificateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, options *CertificateClientCreateOrUpdateOptions) (CertificateClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a certificate. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. certificateName - The parameters supplied to the create or update certificate operation. parameters - The parameters supplied to the create or update certificate operation. options - CertificateClientCreateOrUpdateOptions contains the optional parameters for the CertificateClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCertificateClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount18",
		"testCert",
		armautomation.CertificateCreateOrUpdateParameters{
			Name: to.Ptr("testCert"),
			Properties: &armautomation.CertificateCreateOrUpdateProperties{
				Description:  to.Ptr("Sample Cert"),
				Base64Value:  to.Ptr("base 64 value of cert"),
				IsExportable: to.Ptr(false),
				Thumbprint:   to.Ptr("thumbprint of cert"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CertificateClient) Delete 

func (client *CertificateClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, certificateName string, options *CertificateClientDeleteOptions) (CertificateClientDeleteResponse, error)

Delete - Delete the certificate. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. certificateName - The name of certificate. options - CertificateClientDeleteOptions contains the optional parameters for the CertificateClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCertificateClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount33",
		"testCert",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*CertificateClient) Get 

func (client *CertificateClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, certificateName string, options *CertificateClientGetOptions) (CertificateClientGetResponse, error)

Get - Retrieve the certificate identified by certificate name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. certificateName - The name of certificate. options - CertificateClientGetOptions contains the optional parameters for the CertificateClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCertificateClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"testCert",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CertificateClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *CertificateClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *CertificateClientListByAutomationAccountOptions) *runtime.Pager[CertificateClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of certificates. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - CertificateClientListByAutomationAccountOptions contains the optional parameters for the CertificateClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listCertificatesByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCertificateClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*CertificateClient) Update 

func (client *CertificateClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, certificateName string, parameters CertificateUpdateParameters, options *CertificateClientUpdateOptions) (CertificateClientUpdateResponse, error)

Update - Update a certificate. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. certificateName - The parameters supplied to the update certificate operation. parameters - The parameters supplied to the update certificate operation. options - CertificateClientUpdateOptions contains the optional parameters for the CertificateClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateCertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCertificateClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount33",
		"testCert",
		armautomation.CertificateUpdateParameters{
			Name: to.Ptr("testCert"),
			Properties: &armautomation.CertificateUpdateProperties{
				Description: to.Ptr("sample certificate. Description updated"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type CertificateClientCreateOrUpdateOptions added in v0.3.0 

type CertificateClientCreateOrUpdateOptions struct {
}

CertificateClientCreateOrUpdateOptions contains the optional parameters for the CertificateClient.CreateOrUpdate method.

type CertificateClientCreateOrUpdateResponse added in v0.3.0 

type CertificateClientCreateOrUpdateResponse struct {
	Certificate
}

CertificateClientCreateOrUpdateResponse contains the response from method CertificateClient.CreateOrUpdate.

type CertificateClientDeleteOptions added in v0.3.0 

type CertificateClientDeleteOptions struct {
}

CertificateClientDeleteOptions contains the optional parameters for the CertificateClient.Delete method.

type CertificateClientDeleteResponse added in v0.3.0 

type CertificateClientDeleteResponse struct {
}

CertificateClientDeleteResponse contains the response from method CertificateClient.Delete.

type CertificateClientGetOptions added in v0.3.0 

type CertificateClientGetOptions struct {
}

CertificateClientGetOptions contains the optional parameters for the CertificateClient.Get method.

type CertificateClientGetResponse added in v0.3.0 

type CertificateClientGetResponse struct {
	Certificate
}

CertificateClientGetResponse contains the response from method CertificateClient.Get.

type CertificateClientListByAutomationAccountOptions added in v0.3.0 

type CertificateClientListByAutomationAccountOptions struct {
}

CertificateClientListByAutomationAccountOptions contains the optional parameters for the CertificateClient.ListByAutomationAccount method.

type CertificateClientListByAutomationAccountResponse added in v0.3.0 

type CertificateClientListByAutomationAccountResponse struct {
	CertificateListResult
}

CertificateClientListByAutomationAccountResponse contains the response from method CertificateClient.ListByAutomationAccount.

type CertificateClientUpdateOptions added in v0.3.0 

type CertificateClientUpdateOptions struct {
}

CertificateClientUpdateOptions contains the optional parameters for the CertificateClient.Update method.

type CertificateClientUpdateResponse added in v0.3.0 

type CertificateClientUpdateResponse struct {
	Certificate
}

CertificateClientUpdateResponse contains the response from method CertificateClient.Update.

type CertificateCreateOrUpdateParameters 

type CertificateCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the certificate.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the properties of the certificate.
	Properties *CertificateCreateOrUpdateProperties `json:"properties,omitempty"`
}

CertificateCreateOrUpdateParameters - The parameters supplied to the create or update or replace certificate operation.

type CertificateCreateOrUpdateProperties 

type CertificateCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the base64 encoded value of the certificate.
	Base64Value *string `json:"base64Value,omitempty"`

	// Gets or sets the description of the certificate.
	Description *string `json:"description,omitempty"`

	// Gets or sets the is exportable flag of the certificate.
	IsExportable *bool `json:"isExportable,omitempty"`

	// Gets or sets the thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty"`
}

CertificateCreateOrUpdateProperties - The properties of the create certificate operation.

type CertificateListResult 

type CertificateListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of certificates.
	Value []*Certificate `json:"value,omitempty"`
}

CertificateListResult - The response model for the list certificate operation.

type CertificateProperties 

type CertificateProperties struct {
	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// READ-ONLY; Gets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the expiry time of the certificate.
	ExpiryTime *time.Time `json:"expiryTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the is exportable flag of the certificate.
	IsExportable *bool `json:"isExportable,omitempty" azure:"ro"`

	// READ-ONLY; Gets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the thumbprint of the certificate.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`
}

CertificateProperties - Properties of the certificate.

func (CertificateProperties) MarshalJSON 

func (c CertificateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateProperties.

func (*CertificateProperties) UnmarshalJSON 

func (c *CertificateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateProperties.

type CertificateUpdateParameters 

type CertificateUpdateParameters struct {
	// Gets or sets the name of the certificate.
	Name *string `json:"name,omitempty"`

	// Gets or sets the properties of the certificate.
	Properties *CertificateUpdateProperties `json:"properties,omitempty"`
}

CertificateUpdateParameters - The parameters supplied to the update certificate operation.

func (CertificateUpdateParameters) MarshalJSON 

func (c CertificateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateUpdateParameters.

type CertificateUpdateProperties 

type CertificateUpdateProperties struct {
	// Gets or sets the description of the certificate.
	Description *string `json:"description,omitempty"`
}

CertificateUpdateProperties - The properties of the update certificate operation

type Client added in v0.3.0 

type Client struct {
	// contains filtered or unexported fields
}

Client contains the methods for the AutomationClient group. Don't use this type directly, use NewClient() instead.

func NewClient added in v0.3.0 

func NewClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*Client, error)

NewClient creates a new instance of Client with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*Client) ConvertGraphRunbookContent added in v0.3.0 

func (client *Client) ConvertGraphRunbookContent(ctx context.Context, resourceGroupName string, automationAccountName string, parameters GraphicalRunbookContent, options *ClientConvertGraphRunbookContentOptions) (ClientConvertGraphRunbookContentResponse, error)

ConvertGraphRunbookContent - Post operation to serialize or deserialize GraphRunbookContent If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. parameters - Input data describing the graphical runbook. options - ClientConvertGraphRunbookContentOptions contains the optional parameters for the Client.ConvertGraphRunbookContent method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/serializeGraphRunbookContent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ConvertGraphRunbookContent(ctx,
		"rg",
		"MyAutomationAccount",
		armautomation.GraphicalRunbookContent{
			GraphRunbookJSON: to.Ptr("<GraphRunbookJSON>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type ClientConvertGraphRunbookContentOptions added in v0.3.0 

type ClientConvertGraphRunbookContentOptions struct {
}

ClientConvertGraphRunbookContentOptions contains the optional parameters for the Client.ConvertGraphRunbookContent method.

type ClientConvertGraphRunbookContentResponse added in v0.3.0 

type ClientConvertGraphRunbookContentResponse struct {
	GraphicalRunbookContent
}

ClientConvertGraphRunbookContentResponse contains the response from method Client.ConvertGraphRunbookContent.

type ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties 

type ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties struct {
	// READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

type Connection 

type Connection struct {
	// Gets or sets the properties of the connection.
	Properties *ConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Connection - Definition of the connection.

type ConnectionClient 

type ConnectionClient struct {
	// contains filtered or unexported fields
}

ConnectionClient contains the methods for the Connection group. Don't use this type directly, use NewConnectionClient() instead.

func NewConnectionClient 

func NewConnectionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectionClient, error)

NewConnectionClient creates a new instance of ConnectionClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ConnectionClient) CreateOrUpdate 

func (client *ConnectionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, connectionName string, parameters ConnectionCreateOrUpdateParameters, options *ConnectionClientCreateOrUpdateOptions) (ConnectionClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update a connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionName - The parameters supplied to the create or update connection operation. parameters - The parameters supplied to the create or update connection operation. options - ConnectionClientCreateOrUpdateOptions contains the optional parameters for the ConnectionClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount28",
		"mysConnection",
		armautomation.ConnectionCreateOrUpdateParameters{
			Name: to.Ptr("mysConnection"),
			Properties: &armautomation.ConnectionCreateOrUpdateProperties{
				Description: to.Ptr("my description goes here"),
				ConnectionType: &armautomation.ConnectionTypeAssociationProperty{
					Name: to.Ptr("Azure"),
				},
				FieldDefinitionValues: map[string]*string{
					"AutomationCertificateName": to.Ptr("mysCertificateName"),
					"SubscriptionID":            to.Ptr("subid"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConnectionClient) Delete 

func (client *ConnectionClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, connectionName string, options *ConnectionClientDeleteOptions) (ConnectionClientDeleteResponse, error)

Delete - Delete the connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionName - The name of connection. options - ConnectionClientDeleteOptions contains the optional parameters for the ConnectionClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount28",
		"myConnection",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ConnectionClient) Get 

func (client *ConnectionClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, connectionName string, options *ConnectionClientGetOptions) (ConnectionClientGetResponse, error)

Get - Retrieve the connection identified by connection name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionName - The name of connection. options - ConnectionClientGetOptions contains the optional parameters for the ConnectionClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount28",
		"myConnection",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConnectionClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *ConnectionClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *ConnectionClientListByAutomationAccountOptions) *runtime.Pager[ConnectionClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of connections. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - ConnectionClientListByAutomationAccountOptions contains the optional parameters for the ConnectionClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listConnectionsByAutomationAccount_First100.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount28",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ConnectionClient) Update 

func (client *ConnectionClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, connectionName string, parameters ConnectionUpdateParameters, options *ConnectionClientUpdateOptions) (ConnectionClientUpdateResponse, error)

Update - Update a connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionName - The parameters supplied to the update a connection operation. parameters - The parameters supplied to the update a connection operation. options - ConnectionClientUpdateOptions contains the optional parameters for the ConnectionClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount28",
		"myConnection",
		armautomation.ConnectionUpdateParameters{
			Name: to.Ptr("myConnection"),
			Properties: &armautomation.ConnectionUpdateProperties{
				Description: to.Ptr("my description goes here"),
				FieldDefinitionValues: map[string]*string{
					"AutomationCertificateName": to.Ptr("myCertificateName"),
					"SubscriptionID":            to.Ptr("b5e4748c-f69a-467c-8749-e2f9c8cd3009"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type ConnectionClientCreateOrUpdateOptions added in v0.3.0 

type ConnectionClientCreateOrUpdateOptions struct {
}

ConnectionClientCreateOrUpdateOptions contains the optional parameters for the ConnectionClient.CreateOrUpdate method.

type ConnectionClientCreateOrUpdateResponse added in v0.3.0 

type ConnectionClientCreateOrUpdateResponse struct {
	Connection
}

ConnectionClientCreateOrUpdateResponse contains the response from method ConnectionClient.CreateOrUpdate.

type ConnectionClientDeleteOptions added in v0.3.0 

type ConnectionClientDeleteOptions struct {
}

ConnectionClientDeleteOptions contains the optional parameters for the ConnectionClient.Delete method.

type ConnectionClientDeleteResponse added in v0.3.0 

type ConnectionClientDeleteResponse struct {
}

ConnectionClientDeleteResponse contains the response from method ConnectionClient.Delete.

type ConnectionClientGetOptions added in v0.3.0 

type ConnectionClientGetOptions struct {
}

ConnectionClientGetOptions contains the optional parameters for the ConnectionClient.Get method.

type ConnectionClientGetResponse added in v0.3.0 

type ConnectionClientGetResponse struct {
	Connection
}

ConnectionClientGetResponse contains the response from method ConnectionClient.Get.

type ConnectionClientListByAutomationAccountOptions added in v0.3.0 

type ConnectionClientListByAutomationAccountOptions struct {
}

ConnectionClientListByAutomationAccountOptions contains the optional parameters for the ConnectionClient.ListByAutomationAccount method.

type ConnectionClientListByAutomationAccountResponse added in v0.3.0 

type ConnectionClientListByAutomationAccountResponse struct {
	ConnectionListResult
}

ConnectionClientListByAutomationAccountResponse contains the response from method ConnectionClient.ListByAutomationAccount.

type ConnectionClientUpdateOptions added in v0.3.0 

type ConnectionClientUpdateOptions struct {
}

ConnectionClientUpdateOptions contains the optional parameters for the ConnectionClient.Update method.

type ConnectionClientUpdateResponse added in v0.3.0 

type ConnectionClientUpdateResponse struct {
	Connection
}

ConnectionClientUpdateResponse contains the response from method ConnectionClient.Update.

type ConnectionCreateOrUpdateParameters 

type ConnectionCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the connection.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the properties of the connection.
	Properties *ConnectionCreateOrUpdateProperties `json:"properties,omitempty"`
}

ConnectionCreateOrUpdateParameters - The parameters supplied to the create or update connection operation.

type ConnectionCreateOrUpdateProperties 

type ConnectionCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the connectionType of the connection.
	ConnectionType *ConnectionTypeAssociationProperty `json:"connectionType,omitempty"`

	// Gets or sets the description of the connection.
	Description *string `json:"description,omitempty"`

	// Gets or sets the field definition properties of the connection.
	FieldDefinitionValues map[string]*string `json:"fieldDefinitionValues,omitempty"`
}

ConnectionCreateOrUpdateProperties - The properties of the create connection properties

func (ConnectionCreateOrUpdateProperties) MarshalJSON 

func (c ConnectionCreateOrUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionCreateOrUpdateProperties.

type ConnectionListResult 

type ConnectionListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of connection.
	Value []*Connection `json:"value,omitempty"`
}

ConnectionListResult - The response model for the list connection operation.

type ConnectionProperties 

type ConnectionProperties struct {
	// Gets or sets the connectionType of the connection.
	ConnectionType *ConnectionTypeAssociationProperty `json:"connectionType,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// READ-ONLY; Gets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the field definition values of the connection.
	FieldDefinitionValues map[string]*string `json:"fieldDefinitionValues,omitempty" azure:"ro"`

	// READ-ONLY; Gets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`
}

ConnectionProperties - Definition of the connection properties.

func (ConnectionProperties) MarshalJSON 

func (c ConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionProperties.

func (*ConnectionProperties) UnmarshalJSON 

func (c *ConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionProperties.

type ConnectionType 

type ConnectionType struct {
	// Gets or sets the properties of the connection type.
	Properties *ConnectionTypeProperties `json:"properties,omitempty"`

	// READ-ONLY; Gets the id of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Gets the name of the connection type.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

ConnectionType - Definition of the connection type.

type ConnectionTypeAssociationProperty 

type ConnectionTypeAssociationProperty struct {
	// Gets or sets the name of the connection type.
	Name *string `json:"name,omitempty"`
}

ConnectionTypeAssociationProperty - The connection type property associated with the entity.

type ConnectionTypeClient 

type ConnectionTypeClient struct {
	// contains filtered or unexported fields
}

ConnectionTypeClient contains the methods for the ConnectionType group. Don't use this type directly, use NewConnectionTypeClient() instead.

func NewConnectionTypeClient 

func NewConnectionTypeClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectionTypeClient, error)

NewConnectionTypeClient creates a new instance of ConnectionTypeClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ConnectionTypeClient) CreateOrUpdate 

func (client *ConnectionTypeClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, connectionTypeName string, parameters ConnectionTypeCreateOrUpdateParameters, options *ConnectionTypeClientCreateOrUpdateOptions) (ConnectionTypeClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a connection type. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionTypeName - The parameters supplied to the create or update connection type operation. parameters - The parameters supplied to the create or update connection type operation. options - ConnectionTypeClientCreateOrUpdateOptions contains the optional parameters for the ConnectionTypeClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateConnectionType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionTypeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount22",
		"myCT",
		armautomation.ConnectionTypeCreateOrUpdateParameters{
			Name: to.Ptr("myCT"),
			Properties: &armautomation.ConnectionTypeCreateOrUpdateProperties{
				FieldDefinitions: map[string]*armautomation.FieldDefinition{
					"myBoolField": {
						Type:        to.Ptr("bool"),
						IsEncrypted: to.Ptr(false),
						IsOptional:  to.Ptr(false),
					},
					"myStringField": {
						Type:        to.Ptr("string"),
						IsEncrypted: to.Ptr(false),
						IsOptional:  to.Ptr(false),
					},
					"myStringFieldEncrypted": {
						Type:        to.Ptr("string"),
						IsEncrypted: to.Ptr(true),
						IsOptional:  to.Ptr(false),
					},
				},
				IsGlobal: to.Ptr(false),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ConnectionTypeClient) Delete 

func (client *ConnectionTypeClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, connectionTypeName string, options *ConnectionTypeClientDeleteOptions) (ConnectionTypeClientDeleteResponse, error)

Delete - Delete the connection type. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionTypeName - The name of connection type. options - ConnectionTypeClientDeleteOptions contains the optional parameters for the ConnectionTypeClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteConnectionType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionTypeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount22",
		"myCT",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ConnectionTypeClient) Get 

func (client *ConnectionTypeClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, connectionTypeName string, options *ConnectionTypeClientGetOptions) (ConnectionTypeClientGetResponse, error)

Get - Retrieve the connection type identified by connection type name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. connectionTypeName - The name of connection type. options - ConnectionTypeClientGetOptions contains the optional parameters for the ConnectionTypeClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getConnectionType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionTypeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount22",
		"myCT",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ConnectionTypeClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *ConnectionTypeClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *ConnectionTypeClientListByAutomationAccountOptions) *runtime.Pager[ConnectionTypeClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of connection types. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - ConnectionTypeClientListByAutomationAccountOptions contains the optional parameters for the ConnectionTypeClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getAllConnectionTypes_First100.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewConnectionTypeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount25",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ConnectionTypeClientCreateOrUpdateOptions added in v0.3.0 

type ConnectionTypeClientCreateOrUpdateOptions struct {
}

ConnectionTypeClientCreateOrUpdateOptions contains the optional parameters for the ConnectionTypeClient.CreateOrUpdate method.

type ConnectionTypeClientCreateOrUpdateResponse added in v0.3.0 

type ConnectionTypeClientCreateOrUpdateResponse struct {
	ConnectionType
}

ConnectionTypeClientCreateOrUpdateResponse contains the response from method ConnectionTypeClient.CreateOrUpdate.

type ConnectionTypeClientDeleteOptions added in v0.3.0 

type ConnectionTypeClientDeleteOptions struct {
}

ConnectionTypeClientDeleteOptions contains the optional parameters for the ConnectionTypeClient.Delete method.

type ConnectionTypeClientDeleteResponse added in v0.3.0 

type ConnectionTypeClientDeleteResponse struct {
}

ConnectionTypeClientDeleteResponse contains the response from method ConnectionTypeClient.Delete.

type ConnectionTypeClientGetOptions added in v0.3.0 

type ConnectionTypeClientGetOptions struct {
}

ConnectionTypeClientGetOptions contains the optional parameters for the ConnectionTypeClient.Get method.

type ConnectionTypeClientGetResponse added in v0.3.0 

type ConnectionTypeClientGetResponse struct {
	ConnectionType
}

ConnectionTypeClientGetResponse contains the response from method ConnectionTypeClient.Get.

type ConnectionTypeClientListByAutomationAccountOptions added in v0.3.0 

type ConnectionTypeClientListByAutomationAccountOptions struct {
}

ConnectionTypeClientListByAutomationAccountOptions contains the optional parameters for the ConnectionTypeClient.ListByAutomationAccount method.

type ConnectionTypeClientListByAutomationAccountResponse added in v0.3.0 

type ConnectionTypeClientListByAutomationAccountResponse struct {
	ConnectionTypeListResult
}

ConnectionTypeClientListByAutomationAccountResponse contains the response from method ConnectionTypeClient.ListByAutomationAccount.

type ConnectionTypeCreateOrUpdateParameters 

type ConnectionTypeCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the connection type.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the value of the connection type.
	Properties *ConnectionTypeCreateOrUpdateProperties `json:"properties,omitempty"`
}

ConnectionTypeCreateOrUpdateParameters - The parameters supplied to the create or update connection type operation.

type ConnectionTypeCreateOrUpdateProperties 

type ConnectionTypeCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the field definitions of the connection type.
	FieldDefinitions map[string]*FieldDefinition `json:"fieldDefinitions,omitempty"`

	// Gets or sets a Boolean value to indicate if the connection type is global.
	IsGlobal *bool `json:"isGlobal,omitempty"`
}

ConnectionTypeCreateOrUpdateProperties - The properties of the create connection type.

func (ConnectionTypeCreateOrUpdateProperties) MarshalJSON 

func (c ConnectionTypeCreateOrUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionTypeCreateOrUpdateProperties.

type ConnectionTypeListResult 

type ConnectionTypeListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of connection types.
	Value []*ConnectionType `json:"value,omitempty"`
}

ConnectionTypeListResult - The response model for the list connection type operation.

type ConnectionTypeProperties 

type ConnectionTypeProperties struct {
	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets a Boolean value to indicate if the connection type is global.
	IsGlobal *bool `json:"isGlobal,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// READ-ONLY; Gets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the field definitions of the connection type.
	FieldDefinitions map[string]*FieldDefinition `json:"fieldDefinitions,omitempty" azure:"ro"`
}

ConnectionTypeProperties - Properties of the connection type.

func (*ConnectionTypeProperties) UnmarshalJSON 

func (c *ConnectionTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionTypeProperties.

type ConnectionUpdateParameters 

type ConnectionUpdateParameters struct {
	// Gets or sets the name of the connection.
	Name *string `json:"name,omitempty"`

	// Gets or sets the properties of the connection.
	Properties *ConnectionUpdateProperties `json:"properties,omitempty"`
}

ConnectionUpdateParameters - The parameters supplied to the update connection operation.

func (ConnectionUpdateParameters) MarshalJSON 

func (c ConnectionUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionUpdateParameters.

type ConnectionUpdateProperties 

type ConnectionUpdateProperties struct {
	// Gets or sets the description of the connection.
	Description *string `json:"description,omitempty"`

	// Gets or sets the field definition values of the connection.
	FieldDefinitionValues map[string]*string `json:"fieldDefinitionValues,omitempty"`
}

ConnectionUpdateProperties - The properties of the update connection operation.

func (ConnectionUpdateProperties) MarshalJSON 

func (c ConnectionUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionUpdateProperties.

type ContentHash 

type ContentHash struct {
	// REQUIRED; Gets or sets the content hash algorithm used to hash the content.
	Algorithm *string `json:"algorithm,omitempty"`

	// REQUIRED; Gets or sets expected hash value of the content.
	Value *string `json:"value,omitempty"`
}

ContentHash - Definition of the runbook property type. 

type ContentLink struct {
	// Gets or sets the hash.
	ContentHash *ContentHash `json:"contentHash,omitempty"`

	// Gets or sets the uri of the runbook content.
	URI *string `json:"uri,omitempty"`

	// Gets or sets the version of the content.
	Version *string `json:"version,omitempty"`
}

ContentLink - Definition of the content link.

type ContentSource 

type ContentSource struct {
	// Gets or sets the hash.
	Hash *ContentHash `json:"hash,omitempty"`

	// Gets or sets the content source type.
	Type *ContentSourceType `json:"type,omitempty"`

	// Gets or sets the value of the content. This is based on the content source type.
	Value *string `json:"value,omitempty"`

	// Gets or sets the version of the content.
	Version *string `json:"version,omitempty"`
}

ContentSource - Definition of the content source.

type ContentSourceType 

type ContentSourceType string

ContentSourceType - Gets or sets the content source type. 

const (
	ContentSourceTypeEmbeddedContent ContentSourceType = "embeddedContent"
	ContentSourceTypeURI             ContentSourceType = "uri"
)

func PossibleContentSourceTypeValues 

func PossibleContentSourceTypeValues() []ContentSourceType

PossibleContentSourceTypeValues returns the possible values for the ContentSourceType const type.

type CountType 

type CountType string
const (
	CountTypeNodeconfiguration CountType = "nodeconfiguration"
	CountTypeStatus            CountType = "status"
)

func PossibleCountTypeValues 

func PossibleCountTypeValues() []CountType

PossibleCountTypeValues returns the possible values for the CountType const type.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type Credential 

type Credential struct {
	// Gets or sets the properties of the credential.
	Properties *CredentialProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Credential - Definition of the credential.

type CredentialClient 

type CredentialClient struct {
	// contains filtered or unexported fields
}

CredentialClient contains the methods for the Credential group. Don't use this type directly, use NewCredentialClient() instead.

func NewCredentialClient 

func NewCredentialClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CredentialClient, error)

NewCredentialClient creates a new instance of CredentialClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CredentialClient) CreateOrUpdate 

func (client *CredentialClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, credentialName string, parameters CredentialCreateOrUpdateParameters, options *CredentialClientCreateOrUpdateOptions) (CredentialClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a credential. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. credentialName - The parameters supplied to the create or update credential operation. parameters - The parameters supplied to the create or update credential operation. options - CredentialClientCreateOrUpdateOptions contains the optional parameters for the CredentialClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateCredential.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCredentialClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount18",
		"myCredential",
		armautomation.CredentialCreateOrUpdateParameters{
			Name: to.Ptr("myCredential"),
			Properties: &armautomation.CredentialCreateOrUpdateProperties{
				Description: to.Ptr("my description goes here"),
				Password:    to.Ptr("<password>"),
				UserName:    to.Ptr("mylingaiah"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CredentialClient) Delete 

func (client *CredentialClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, credentialName string, options *CredentialClientDeleteOptions) (CredentialClientDeleteResponse, error)

Delete - Delete the credential. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. credentialName - The name of credential. options - CredentialClientDeleteOptions contains the optional parameters for the CredentialClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteCredentialExisting.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCredentialClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount20",
		"myCredential",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*CredentialClient) Get 

func (client *CredentialClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, credentialName string, options *CredentialClientGetOptions) (CredentialClientGetResponse, error)

Get - Retrieve the credential identified by credential name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. credentialName - The name of credential. options - CredentialClientGetOptions contains the optional parameters for the CredentialClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getCredential.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCredentialClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount18",
		"myCredential",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*CredentialClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *CredentialClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *CredentialClientListByAutomationAccountOptions) *runtime.Pager[CredentialClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of credentials. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - CredentialClientListByAutomationAccountOptions contains the optional parameters for the CredentialClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listCredentialsByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCredentialClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount20",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*CredentialClient) Update 

func (client *CredentialClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, credentialName string, parameters CredentialUpdateParameters, options *CredentialClientUpdateOptions) (CredentialClientUpdateResponse, error)

Update - Update a credential. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. credentialName - The parameters supplied to the Update credential operation. parameters - The parameters supplied to the Update credential operation. options - CredentialClientUpdateOptions contains the optional parameters for the CredentialClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateCredential_patch.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewCredentialClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount18",
		"myCredential",
		armautomation.CredentialUpdateParameters{
			Name: to.Ptr("myCredential"),
			Properties: &armautomation.CredentialUpdateProperties{
				Description: to.Ptr("my description goes here"),
				Password:    to.Ptr("<password>"),
				UserName:    to.Ptr("mylingaiah"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type CredentialClientCreateOrUpdateOptions added in v0.3.0 

type CredentialClientCreateOrUpdateOptions struct {
}

CredentialClientCreateOrUpdateOptions contains the optional parameters for the CredentialClient.CreateOrUpdate method.

type CredentialClientCreateOrUpdateResponse added in v0.3.0 

type CredentialClientCreateOrUpdateResponse struct {
	Credential
}

CredentialClientCreateOrUpdateResponse contains the response from method CredentialClient.CreateOrUpdate.

type CredentialClientDeleteOptions added in v0.3.0 

type CredentialClientDeleteOptions struct {
}

CredentialClientDeleteOptions contains the optional parameters for the CredentialClient.Delete method.

type CredentialClientDeleteResponse added in v0.3.0 

type CredentialClientDeleteResponse struct {
}

CredentialClientDeleteResponse contains the response from method CredentialClient.Delete.

type CredentialClientGetOptions added in v0.3.0 

type CredentialClientGetOptions struct {
}

CredentialClientGetOptions contains the optional parameters for the CredentialClient.Get method.

type CredentialClientGetResponse added in v0.3.0 

type CredentialClientGetResponse struct {
	Credential
}

CredentialClientGetResponse contains the response from method CredentialClient.Get.

type CredentialClientListByAutomationAccountOptions added in v0.3.0 

type CredentialClientListByAutomationAccountOptions struct {
}

CredentialClientListByAutomationAccountOptions contains the optional parameters for the CredentialClient.ListByAutomationAccount method.

type CredentialClientListByAutomationAccountResponse added in v0.3.0 

type CredentialClientListByAutomationAccountResponse struct {
	CredentialListResult
}

CredentialClientListByAutomationAccountResponse contains the response from method CredentialClient.ListByAutomationAccount.

type CredentialClientUpdateOptions added in v0.3.0 

type CredentialClientUpdateOptions struct {
}

CredentialClientUpdateOptions contains the optional parameters for the CredentialClient.Update method.

type CredentialClientUpdateResponse added in v0.3.0 

type CredentialClientUpdateResponse struct {
	Credential
}

CredentialClientUpdateResponse contains the response from method CredentialClient.Update.

type CredentialCreateOrUpdateParameters 

type CredentialCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the credential.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the properties of the credential.
	Properties *CredentialCreateOrUpdateProperties `json:"properties,omitempty"`
}

CredentialCreateOrUpdateParameters - The parameters supplied to the create or update credential operation.

type CredentialCreateOrUpdateProperties 

type CredentialCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the password of the credential.
	Password *string `json:"password,omitempty"`

	// REQUIRED; Gets or sets the user name of the credential.
	UserName *string `json:"userName,omitempty"`

	// Gets or sets the description of the credential.
	Description *string `json:"description,omitempty"`
}

CredentialCreateOrUpdateProperties - The properties of the create credential operation.

type CredentialListResult 

type CredentialListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of credentials.
	Value []*Credential `json:"value,omitempty"`
}

CredentialListResult - The response model for the list credential operation.

type CredentialProperties 

type CredentialProperties struct {
	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// READ-ONLY; Gets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the user name of the credential.
	UserName *string `json:"userName,omitempty" azure:"ro"`
}

CredentialProperties - Definition of the credential properties

func (CredentialProperties) MarshalJSON 

func (c CredentialProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CredentialProperties.

func (*CredentialProperties) UnmarshalJSON 

func (c *CredentialProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CredentialProperties.

type CredentialUpdateParameters 

type CredentialUpdateParameters struct {
	// Gets or sets the name of the credential.
	Name *string `json:"name,omitempty"`

	// Gets or sets the properties of the variable.
	Properties *CredentialUpdateProperties `json:"properties,omitempty"`
}

CredentialUpdateParameters - The parameters supplied to the Update credential operation.

func (CredentialUpdateParameters) MarshalJSON 

func (c CredentialUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CredentialUpdateParameters.

type CredentialUpdateProperties 

type CredentialUpdateProperties struct {
	// Gets or sets the description of the credential.
	Description *string `json:"description,omitempty"`

	// Gets or sets the password of the credential.
	Password *string `json:"password,omitempty"`

	// Gets or sets the user name of the credential.
	UserName *string `json:"userName,omitempty"`
}

CredentialUpdateProperties - The properties of the Update credential

type DscCompilationJob 

type DscCompilationJob struct {
	// Gets or sets the properties of the Dsc Compilation job.
	Properties *DscCompilationJobProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DscCompilationJob - Definition of the Dsc Compilation job.

type DscCompilationJobClient 

type DscCompilationJobClient struct {
	// contains filtered or unexported fields
}

DscCompilationJobClient contains the methods for the DscCompilationJob group. Don't use this type directly, use NewDscCompilationJobClient() instead.

func NewDscCompilationJobClient 

func NewDscCompilationJobClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DscCompilationJobClient, error)

NewDscCompilationJobClient creates a new instance of DscCompilationJobClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DscCompilationJobClient) BeginCreate 

func (client *DscCompilationJobClient) BeginCreate(ctx context.Context, resourceGroupName string, automationAccountName string, compilationJobName string, parameters DscCompilationJobCreateParameters, options *DscCompilationJobClientBeginCreateOptions) (*runtime.Poller[DscCompilationJobClientCreateResponse], error)

BeginCreate - Creates the Dsc compilation job of the configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. compilationJobName - The DSC configuration Id. parameters - The parameters supplied to the create compilation job operation. options - DscCompilationJobClientBeginCreateOptions contains the optional parameters for the DscCompilationJobClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createCompilationJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscCompilationJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreate(ctx,
		"rg",
		"myAutomationAccount33",
		"TestCompilationJob",
		armautomation.DscCompilationJobCreateParameters{
			Properties: &armautomation.DscCompilationJobCreateProperties{
				Configuration: &armautomation.DscConfigurationAssociationProperty{
					Name: to.Ptr("SetupServer"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DscCompilationJobClient) Get 

func (client *DscCompilationJobClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, compilationJobName string, options *DscCompilationJobClientGetOptions) (DscCompilationJobClientGetResponse, error)

Get - Retrieve the Dsc configuration compilation job identified by job id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. compilationJobName - The DSC configuration Id. options - DscCompilationJobClientGetOptions contains the optional parameters for the DscCompilationJobClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getCompilationJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscCompilationJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"TestCompilationJob",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DscCompilationJobClient) GetStream 

func (client *DscCompilationJobClient) GetStream(ctx context.Context, resourceGroupName string, automationAccountName string, jobID string, jobStreamID string, options *DscCompilationJobClientGetStreamOptions) (DscCompilationJobClientGetStreamResponse, error)

GetStream - Retrieve the job stream identified by job stream id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobID - The job id. jobStreamID - The job stream id. options - DscCompilationJobClientGetStreamOptions contains the optional parameters for the DscCompilationJobClient.GetStream method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/compilationJobStreamByJobStreamId.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscCompilationJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetStream(ctx,
		"rg",
		"myAutomationAccount33",
		"836d4e06-2d88-46b4-8500-7febd4906838",
		"836d4e06-2d88-46b4-8500-7febd4906838_00636481062421684835_00000000000000000008",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DscCompilationJobClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *DscCompilationJobClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *DscCompilationJobClientListByAutomationAccountOptions) *runtime.Pager[DscCompilationJobClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of dsc compilation jobs. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - DscCompilationJobClientListByAutomationAccountOptions contains the optional parameters for the DscCompilationJobClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listCompilationJobsByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscCompilationJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		&armautomation.DscCompilationJobClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type DscCompilationJobClientBeginCreateOptions added in v0.3.0 

type DscCompilationJobClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DscCompilationJobClientBeginCreateOptions contains the optional parameters for the DscCompilationJobClient.BeginCreate method.

type DscCompilationJobClientCreateResponse added in v0.3.0 

type DscCompilationJobClientCreateResponse struct {
	DscCompilationJob
}

DscCompilationJobClientCreateResponse contains the response from method DscCompilationJobClient.Create.

type DscCompilationJobClientGetOptions added in v0.3.0 

type DscCompilationJobClientGetOptions struct {
}

DscCompilationJobClientGetOptions contains the optional parameters for the DscCompilationJobClient.Get method.

type DscCompilationJobClientGetResponse added in v0.3.0 

type DscCompilationJobClientGetResponse struct {
	DscCompilationJob
}

DscCompilationJobClientGetResponse contains the response from method DscCompilationJobClient.Get.

type DscCompilationJobClientGetStreamOptions added in v0.3.0 

type DscCompilationJobClientGetStreamOptions struct {
}

DscCompilationJobClientGetStreamOptions contains the optional parameters for the DscCompilationJobClient.GetStream method.

type DscCompilationJobClientGetStreamResponse added in v0.3.0 

type DscCompilationJobClientGetStreamResponse struct {
	JobStream
}

DscCompilationJobClientGetStreamResponse contains the response from method DscCompilationJobClient.GetStream.

type DscCompilationJobClientListByAutomationAccountOptions added in v0.3.0 

type DscCompilationJobClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

DscCompilationJobClientListByAutomationAccountOptions contains the optional parameters for the DscCompilationJobClient.ListByAutomationAccount method.

type DscCompilationJobClientListByAutomationAccountResponse added in v0.3.0 

type DscCompilationJobClientListByAutomationAccountResponse struct {
	DscCompilationJobListResult
}

DscCompilationJobClientListByAutomationAccountResponse contains the response from method DscCompilationJobClient.ListByAutomationAccount.

type DscCompilationJobCreateParameters 

type DscCompilationJobCreateParameters struct {
	// REQUIRED; Gets or sets the list of compilation job properties.
	Properties *DscCompilationJobCreateProperties `json:"properties,omitempty"`

	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

DscCompilationJobCreateParameters - The parameters supplied to the create compilation job operation.

func (DscCompilationJobCreateParameters) MarshalJSON 

func (d DscCompilationJobCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscCompilationJobCreateParameters.

type DscCompilationJobCreateProperties 

type DscCompilationJobCreateProperties struct {
	// REQUIRED; Gets or sets the configuration.
	Configuration *DscConfigurationAssociationProperty `json:"configuration,omitempty"`

	// If a new build version of NodeConfiguration is required.
	IncrementNodeConfigurationBuild *bool `json:"incrementNodeConfigurationBuild,omitempty"`

	// Gets or sets the parameters of the job.
	Parameters map[string]*string `json:"parameters,omitempty"`
}

DscCompilationJobCreateProperties - The parameters supplied to the create compilation job operation.

func (DscCompilationJobCreateProperties) MarshalJSON 

func (d DscCompilationJobCreateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscCompilationJobCreateProperties.

type DscCompilationJobListResult 

type DscCompilationJobListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of Dsc Compilation jobs.
	Value []*DscCompilationJob `json:"value,omitempty"`
}

DscCompilationJobListResult - The response model for the list job operation.

type DscCompilationJobProperties 

type DscCompilationJobProperties struct {
	// Gets or sets the configuration.
	Configuration *DscConfigurationAssociationProperty `json:"configuration,omitempty"`

	// Gets or sets the parameters of the job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// The current provisioning state of the job.
	ProvisioningState *JobProvisioningState `json:"provisioningState,omitempty"`

	// Gets or sets the runOn which specifies the group name where the job is to be executed.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the status of the job.
	Status *JobStatus `json:"status,omitempty"`

	// Gets or sets the status details of the job.
	StatusDetails *string `json:"statusDetails,omitempty"`

	// READ-ONLY; Gets the creation time of the job.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the end time of the job.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the exception of the job.
	Exception *string `json:"exception,omitempty" azure:"ro"`

	// READ-ONLY; Gets the id of the job.
	JobID *string `json:"jobId,omitempty" azure:"ro"`

	// READ-ONLY; Gets the last modified time of the job.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the last status modified time of the job.
	LastStatusModifiedTime *time.Time `json:"lastStatusModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the start time of the job.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the compilation job started by.
	StartedBy *string `json:"startedBy,omitempty" azure:"ro"`
}

DscCompilationJobProperties - Definition of Dsc Compilation job properties.

func (DscCompilationJobProperties) MarshalJSON 

func (d DscCompilationJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscCompilationJobProperties.

func (*DscCompilationJobProperties) UnmarshalJSON 

func (d *DscCompilationJobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscCompilationJobProperties.

type DscCompilationJobStreamClient 

type DscCompilationJobStreamClient struct {
	// contains filtered or unexported fields
}

DscCompilationJobStreamClient contains the methods for the DscCompilationJobStream group. Don't use this type directly, use NewDscCompilationJobStreamClient() instead.

func NewDscCompilationJobStreamClient 

func NewDscCompilationJobStreamClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DscCompilationJobStreamClient, error)

NewDscCompilationJobStreamClient creates a new instance of DscCompilationJobStreamClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DscCompilationJobStreamClient) ListByJob 

func (client *DscCompilationJobStreamClient) ListByJob(ctx context.Context, resourceGroupName string, automationAccountName string, jobID string, options *DscCompilationJobStreamClientListByJobOptions) (DscCompilationJobStreamClientListByJobResponse, error)

ListByJob - Retrieve all the job streams for the compilation Job. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobID - The job id. options - DscCompilationJobStreamClientListByJobOptions contains the optional parameters for the DscCompilationJobStreamClient.ListByJob method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/compilationJobStreamList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscCompilationJobStreamClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByJob(ctx,
		"rg",
		"myAutomationAccount33",
		"836d4e06-2d88-46b4-8500-7febd4906838",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type DscCompilationJobStreamClientListByJobOptions added in v0.3.0 

type DscCompilationJobStreamClientListByJobOptions struct {
}

DscCompilationJobStreamClientListByJobOptions contains the optional parameters for the DscCompilationJobStreamClient.ListByJob method.

type DscCompilationJobStreamClientListByJobResponse added in v0.3.0 

type DscCompilationJobStreamClientListByJobResponse struct {
	JobStreamListResult
}

DscCompilationJobStreamClientListByJobResponse contains the response from method DscCompilationJobStreamClient.ListByJob.

type DscConfiguration 

type DscConfiguration struct {
	// Gets or sets the etag of the resource.
	Etag *string `json:"etag,omitempty"`

	// The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`

	// Gets or sets the configuration properties.
	Properties *DscConfigurationProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DscConfiguration - Definition of the configuration type.

func (DscConfiguration) MarshalJSON 

func (d DscConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscConfiguration.

type DscConfigurationAssociationProperty 

type DscConfigurationAssociationProperty struct {
	// Gets or sets the name of the Dsc configuration.
	Name *string `json:"name,omitempty"`
}

DscConfigurationAssociationProperty - The Dsc configuration property associated with the entity.

type DscConfigurationClient 

type DscConfigurationClient struct {
	// contains filtered or unexported fields
}

DscConfigurationClient contains the methods for the DscConfiguration group. Don't use this type directly, use NewDscConfigurationClient() instead.

func NewDscConfigurationClient 

func NewDscConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DscConfigurationClient, error)

NewDscConfigurationClient creates a new instance of DscConfigurationClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DscConfigurationClient) CreateOrUpdateWithJSON added in v0.3.0 

func (client *DscConfigurationClient) CreateOrUpdateWithJSON(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, parameters DscConfigurationCreateOrUpdateParameters, options *DscConfigurationClientCreateOrUpdateWithJSONOptions) (DscConfigurationClientCreateOrUpdateWithJSONResponse, error)

CreateOrUpdateWithJSON - Create the configuration identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The create or update parameters for configuration. parameters - The create or update parameters for configuration. options - DscConfigurationClientCreateOrUpdateWithJSONOptions contains the optional parameters for the DscConfigurationClient.CreateOrUpdateWithJSON method.

func (*DscConfigurationClient) CreateOrUpdateWithText added in v0.3.0 

func (client *DscConfigurationClient) CreateOrUpdateWithText(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, parameters string, options *DscConfigurationClientCreateOrUpdateWithTextOptions) (DscConfigurationClientCreateOrUpdateWithTextResponse, error)

CreateOrUpdateWithText - Create the configuration identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The create or update parameters for configuration. parameters - The create or update parameters for configuration. options - DscConfigurationClientCreateOrUpdateWithTextOptions contains the optional parameters for the DscConfigurationClient.CreateOrUpdateWithText method.

func (*DscConfigurationClient) Delete 

func (client *DscConfigurationClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, options *DscConfigurationClientDeleteOptions) (DscConfigurationClientDeleteResponse, error)

Delete - Delete the dsc configuration identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The configuration name. options - DscConfigurationClientDeleteOptions contains the optional parameters for the DscConfigurationClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/deleteDscConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount33",
		"TemplateBasic",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DscConfigurationClient) Get 

func (client *DscConfigurationClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, options *DscConfigurationClientGetOptions) (DscConfigurationClientGetResponse, error)

Get - Retrieve the configuration identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The configuration name. options - DscConfigurationClientGetOptions contains the optional parameters for the DscConfigurationClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/getDscConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"TemplateBasic",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DscConfigurationClient) GetContent 

func (client *DscConfigurationClient) GetContent(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, options *DscConfigurationClientGetContentOptions) (DscConfigurationClientGetContentResponse, error)

GetContent - Retrieve the configuration script identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The configuration name. options - DscConfigurationClientGetContentOptions contains the optional parameters for the DscConfigurationClient.GetContent method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/getDscConfigurationContent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetContent(ctx,
		"rg",
		"myAutomationAccount33",
		"ConfigName",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DscConfigurationClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *DscConfigurationClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *DscConfigurationClientListByAutomationAccountOptions) *runtime.Pager[DscConfigurationClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of configurations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - DscConfigurationClientListByAutomationAccountOptions contains the optional parameters for the DscConfigurationClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/getAllDscConfigurations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		&armautomation.DscConfigurationClientListByAutomationAccountOptions{Filter: nil,
			Skip:        nil,
			Top:         nil,
			Inlinecount: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*DscConfigurationClient) UpdateWithJSON added in v0.3.0 

func (client *DscConfigurationClient) UpdateWithJSON(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, options *DscConfigurationClientUpdateWithJSONOptions) (DscConfigurationClientUpdateWithJSONResponse, error)

UpdateWithJSON - Create the configuration identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The create or update parameters for configuration. options - DscConfigurationClientUpdateWithJSONOptions contains the optional parameters for the DscConfigurationClient.UpdateWithJSON method.

func (*DscConfigurationClient) UpdateWithText added in v0.3.0 

func (client *DscConfigurationClient) UpdateWithText(ctx context.Context, resourceGroupName string, automationAccountName string, configurationName string, options *DscConfigurationClientUpdateWithTextOptions) (DscConfigurationClientUpdateWithTextResponse, error)

UpdateWithText - Create the configuration identified by configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. configurationName - The create or update parameters for configuration. options - DscConfigurationClientUpdateWithTextOptions contains the optional parameters for the DscConfigurationClient.UpdateWithText method.

type DscConfigurationClientCreateOrUpdateWithJSONOptions added in v0.3.0 

type DscConfigurationClientCreateOrUpdateWithJSONOptions struct {
}

DscConfigurationClientCreateOrUpdateWithJSONOptions contains the optional parameters for the DscConfigurationClient.CreateOrUpdateWithJSON method.

type DscConfigurationClientCreateOrUpdateWithJSONResponse added in v0.3.0 

type DscConfigurationClientCreateOrUpdateWithJSONResponse struct {
	DscConfiguration
}

DscConfigurationClientCreateOrUpdateWithJSONResponse contains the response from method DscConfigurationClient.CreateOrUpdateWithJSON.

type DscConfigurationClientCreateOrUpdateWithTextOptions added in v0.3.0 

type DscConfigurationClientCreateOrUpdateWithTextOptions struct {
}

DscConfigurationClientCreateOrUpdateWithTextOptions contains the optional parameters for the DscConfigurationClient.CreateOrUpdateWithText method.

type DscConfigurationClientCreateOrUpdateWithTextResponse added in v0.3.0 

type DscConfigurationClientCreateOrUpdateWithTextResponse struct {
	DscConfiguration
}

DscConfigurationClientCreateOrUpdateWithTextResponse contains the response from method DscConfigurationClient.CreateOrUpdateWithText.

type DscConfigurationClientDeleteOptions added in v0.3.0 

type DscConfigurationClientDeleteOptions struct {
}

DscConfigurationClientDeleteOptions contains the optional parameters for the DscConfigurationClient.Delete method.

type DscConfigurationClientDeleteResponse added in v0.3.0 

type DscConfigurationClientDeleteResponse struct {
}

DscConfigurationClientDeleteResponse contains the response from method DscConfigurationClient.Delete.

type DscConfigurationClientGetContentOptions added in v0.3.0 

type DscConfigurationClientGetContentOptions struct {
}

DscConfigurationClientGetContentOptions contains the optional parameters for the DscConfigurationClient.GetContent method.

type DscConfigurationClientGetContentResponse added in v0.3.0 

type DscConfigurationClientGetContentResponse struct {
	Value *string
}

DscConfigurationClientGetContentResponse contains the response from method DscConfigurationClient.GetContent.

type DscConfigurationClientGetOptions added in v0.3.0 

type DscConfigurationClientGetOptions struct {
}

DscConfigurationClientGetOptions contains the optional parameters for the DscConfigurationClient.Get method.

type DscConfigurationClientGetResponse added in v0.3.0 

type DscConfigurationClientGetResponse struct {
	DscConfiguration
}

DscConfigurationClientGetResponse contains the response from method DscConfigurationClient.Get.

type DscConfigurationClientListByAutomationAccountOptions added in v0.3.0 

type DscConfigurationClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
	// Return total rows.
	Inlinecount *string
	// The number of rows to skip.
	Skip *int32
	// The number of rows to take.
	Top *int32
}

DscConfigurationClientListByAutomationAccountOptions contains the optional parameters for the DscConfigurationClient.ListByAutomationAccount method.

type DscConfigurationClientListByAutomationAccountResponse added in v0.3.0 

type DscConfigurationClientListByAutomationAccountResponse struct {
	DscConfigurationListResult
}

DscConfigurationClientListByAutomationAccountResponse contains the response from method DscConfigurationClient.ListByAutomationAccount.

type DscConfigurationClientUpdateWithJSONOptions added in v0.3.0 

type DscConfigurationClientUpdateWithJSONOptions struct {
	// The create or update parameters for configuration.
	Parameters *DscConfigurationUpdateParameters
}

DscConfigurationClientUpdateWithJSONOptions contains the optional parameters for the DscConfigurationClient.UpdateWithJSON method.

type DscConfigurationClientUpdateWithJSONResponse added in v0.3.0 

type DscConfigurationClientUpdateWithJSONResponse struct {
	DscConfiguration
}

DscConfigurationClientUpdateWithJSONResponse contains the response from method DscConfigurationClient.UpdateWithJSON.

type DscConfigurationClientUpdateWithTextOptions added in v0.3.0 

type DscConfigurationClientUpdateWithTextOptions struct {
	// The create or update parameters for configuration.
	Parameters *string
}

DscConfigurationClientUpdateWithTextOptions contains the optional parameters for the DscConfigurationClient.UpdateWithText method.

type DscConfigurationClientUpdateWithTextResponse added in v0.3.0 

type DscConfigurationClientUpdateWithTextResponse struct {
	DscConfiguration
}

DscConfigurationClientUpdateWithTextResponse contains the response from method DscConfigurationClient.UpdateWithText.

type DscConfigurationCreateOrUpdateParameters 

type DscConfigurationCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets configuration create or update properties.
	Properties *DscConfigurationCreateOrUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

DscConfigurationCreateOrUpdateParameters - The parameters supplied to the create or update configuration operation.

func (DscConfigurationCreateOrUpdateParameters) MarshalJSON 

func (d DscConfigurationCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscConfigurationCreateOrUpdateParameters.

type DscConfigurationCreateOrUpdateProperties 

type DscConfigurationCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the source.
	Source *ContentSource `json:"source,omitempty"`

	// Gets or sets the description of the configuration.
	Description *string `json:"description,omitempty"`

	// Gets or sets progress log option.
	LogProgress *bool `json:"logProgress,omitempty"`

	// Gets or sets verbose log option.
	LogVerbose *bool `json:"logVerbose,omitempty"`

	// Gets or sets the configuration parameters.
	Parameters map[string]*DscConfigurationParameter `json:"parameters,omitempty"`
}

DscConfigurationCreateOrUpdateProperties - The properties to create or update configuration.

func (DscConfigurationCreateOrUpdateProperties) MarshalJSON 

func (d DscConfigurationCreateOrUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscConfigurationCreateOrUpdateProperties.

type DscConfigurationListResult 

type DscConfigurationListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets the total number of configurations matching filter criteria.
	TotalCount *int32 `json:"totalCount,omitempty"`

	// Gets or sets a list of configurations.
	Value []*DscConfiguration `json:"value,omitempty"`
}

DscConfigurationListResult - The response model for the list configuration operation.

type DscConfigurationParameter 

type DscConfigurationParameter struct {
	// Gets or sets the default value of parameter.
	DefaultValue *string `json:"defaultValue,omitempty"`

	// Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
	IsMandatory *bool `json:"isMandatory,omitempty"`

	// Get or sets the position of the parameter.
	Position *int32 `json:"position,omitempty"`

	// Gets or sets the type of the parameter.
	Type *string `json:"type,omitempty"`
}

DscConfigurationParameter - Definition of the configuration parameter type.

type DscConfigurationProperties 

type DscConfigurationProperties struct {
	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the job count of the configuration.
	JobCount *int32 `json:"jobCount,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets verbose log option.
	LogVerbose *bool `json:"logVerbose,omitempty"`

	// Gets the number of compiled node configurations.
	NodeConfigurationCount *int32 `json:"nodeConfigurationCount,omitempty"`

	// Gets or sets the configuration parameters.
	Parameters map[string]*DscConfigurationParameter `json:"parameters,omitempty"`

	// Gets or sets the provisioning state of the configuration.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Gets or sets the source.
	Source *ContentSource `json:"source,omitempty"`

	// Gets or sets the state of the configuration.
	State *DscConfigurationState `json:"state,omitempty"`
}

DscConfigurationProperties - Definition of the configuration property type.

func (DscConfigurationProperties) MarshalJSON 

func (d DscConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscConfigurationProperties.

func (*DscConfigurationProperties) UnmarshalJSON 

func (d *DscConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscConfigurationProperties.

type DscConfigurationState 

type DscConfigurationState string

DscConfigurationState - Gets or sets the state of the configuration. 

const (
	DscConfigurationStateEdit      DscConfigurationState = "Edit"
	DscConfigurationStateNew       DscConfigurationState = "New"
	DscConfigurationStatePublished DscConfigurationState = "Published"
)

func PossibleDscConfigurationStateValues 

func PossibleDscConfigurationStateValues() []DscConfigurationState

PossibleDscConfigurationStateValues returns the possible values for the DscConfigurationState const type.

type DscConfigurationUpdateParameters 

type DscConfigurationUpdateParameters struct {
	// Gets or sets name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets configuration create or update properties.
	Properties *DscConfigurationCreateOrUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

DscConfigurationUpdateParameters - The parameters supplied to the create or update configuration operation.

func (DscConfigurationUpdateParameters) MarshalJSON 

func (d DscConfigurationUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscConfigurationUpdateParameters.

type DscMetaConfiguration 

type DscMetaConfiguration struct {
	// Gets or sets the ActionAfterReboot value of the meta configuration.
	ActionAfterReboot *string `json:"actionAfterReboot,omitempty"`

	// Gets or sets the AllowModuleOverwrite value of the meta configuration.
	AllowModuleOverwrite *bool `json:"allowModuleOverwrite,omitempty"`

	// Gets or sets the CertificateId value of the meta configuration.
	CertificateID *string `json:"certificateId,omitempty"`

	// Gets or sets the ConfigurationMode value of the meta configuration.
	ConfigurationMode *string `json:"configurationMode,omitempty"`

	// Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration.
	ConfigurationModeFrequencyMins *int32 `json:"configurationModeFrequencyMins,omitempty"`

	// Gets or sets the RebootNodeIfNeeded value of the meta configuration.
	RebootNodeIfNeeded *bool `json:"rebootNodeIfNeeded,omitempty"`

	// Gets or sets the RefreshFrequencyMins value of the meta configuration.
	RefreshFrequencyMins *int32 `json:"refreshFrequencyMins,omitempty"`
}

DscMetaConfiguration - Definition of the DSC Meta Configuration.

type DscNode 

type DscNode struct {
	// The properties of a DscNode.
	Properties *DscNodeProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DscNode - Definition of a DscNode

type DscNodeClient 

type DscNodeClient struct {
	// contains filtered or unexported fields
}

DscNodeClient contains the methods for the DscNode group. Don't use this type directly, use NewDscNodeClient() instead.

func NewDscNodeClient 

func NewDscNodeClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DscNodeClient, error)

NewDscNodeClient creates a new instance of DscNodeClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DscNodeClient) Delete 

func (client *DscNodeClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, nodeID string, options *DscNodeClientDeleteOptions) (DscNodeClientDeleteResponse, error)

Delete - Delete the dsc node identified by node id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeID - The node id. options - DscNodeClientDeleteOptions contains the optional parameters for the DscNodeClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteDscNode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount9",
		"e1243a76-a9bd-432f-bde3-ad8f317ee786",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DscNodeClient) Get 

func (client *DscNodeClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, nodeID string, options *DscNodeClientGetOptions) (DscNodeClientGetResponse, error)

Get - Retrieve the dsc node identified by node id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeID - The node id. options - DscNodeClientGetOptions contains the optional parameters for the DscNodeClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getDscNode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"nodeId",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DscNodeClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *DscNodeClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *DscNodeClientListByAutomationAccountOptions) *runtime.Pager[DscNodeClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of dsc nodes. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - DscNodeClientListByAutomationAccountOptions contains the optional parameters for the DscNodeClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listAllDscNodesByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		&armautomation.DscNodeClientListByAutomationAccountOptions{Filter: nil,
			Skip:        nil,
			Top:         nil,
			Inlinecount: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*DscNodeClient) Update 

func (client *DscNodeClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, nodeID string, dscNodeUpdateParameters DscNodeUpdateParameters, options *DscNodeClientUpdateOptions) (DscNodeClientUpdateResponse, error)

Update - Update the dsc node. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeID - Parameters supplied to the update dsc node. dscNodeUpdateParameters - Parameters supplied to the update dsc node. options - DscNodeClientUpdateOptions contains the optional parameters for the DscNodeClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateDscNode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount33",
		"nodeId",
		armautomation.DscNodeUpdateParameters{
			NodeID: to.Ptr("nodeId"),
			Properties: &armautomation.DscNodeUpdateParametersProperties{
				NodeConfiguration: &armautomation.DscNodeConfigurationAssociationProperty{
					Name: to.Ptr("SetupServer.localhost"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type DscNodeClientDeleteOptions added in v0.3.0 

type DscNodeClientDeleteOptions struct {
}

DscNodeClientDeleteOptions contains the optional parameters for the DscNodeClient.Delete method.

type DscNodeClientDeleteResponse added in v0.3.0 

type DscNodeClientDeleteResponse struct {
}

DscNodeClientDeleteResponse contains the response from method DscNodeClient.Delete.

type DscNodeClientGetOptions added in v0.3.0 

type DscNodeClientGetOptions struct {
}

DscNodeClientGetOptions contains the optional parameters for the DscNodeClient.Get method.

type DscNodeClientGetResponse added in v0.3.0 

type DscNodeClientGetResponse struct {
	DscNode
}

DscNodeClientGetResponse contains the response from method DscNodeClient.Get.

type DscNodeClientListByAutomationAccountOptions added in v0.3.0 

type DscNodeClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
	// Return total rows.
	Inlinecount *string
	// The number of rows to skip.
	Skip *int32
	// The number of rows to take.
	Top *int32
}

DscNodeClientListByAutomationAccountOptions contains the optional parameters for the DscNodeClient.ListByAutomationAccount method.

type DscNodeClientListByAutomationAccountResponse added in v0.3.0 

type DscNodeClientListByAutomationAccountResponse struct {
	DscNodeListResult
}

DscNodeClientListByAutomationAccountResponse contains the response from method DscNodeClient.ListByAutomationAccount.

type DscNodeClientUpdateOptions added in v0.3.0 

type DscNodeClientUpdateOptions struct {
}

DscNodeClientUpdateOptions contains the optional parameters for the DscNodeClient.Update method.

type DscNodeClientUpdateResponse added in v0.3.0 

type DscNodeClientUpdateResponse struct {
	DscNode
}

DscNodeClientUpdateResponse contains the response from method DscNodeClient.Update.

type DscNodeConfiguration 

type DscNodeConfiguration struct {
	// Gets or sets the configuration properties.
	Properties *DscNodeConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DscNodeConfiguration - Definition of the dsc node configuration.

type DscNodeConfigurationAssociationProperty 

type DscNodeConfigurationAssociationProperty struct {
	// Gets or sets the name of the dsc node configuration.
	Name *string `json:"name,omitempty"`
}

DscNodeConfigurationAssociationProperty - The dsc node configuration property associated with the entity.

type DscNodeConfigurationClient 

type DscNodeConfigurationClient struct {
	// contains filtered or unexported fields
}

DscNodeConfigurationClient contains the methods for the DscNodeConfiguration group. Don't use this type directly, use NewDscNodeConfigurationClient() instead.

func NewDscNodeConfigurationClient 

func NewDscNodeConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DscNodeConfigurationClient, error)

NewDscNodeConfigurationClient creates a new instance of DscNodeConfigurationClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DscNodeConfigurationClient) BeginCreateOrUpdate 

func (client *DscNodeConfigurationClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, nodeConfigurationName string, parameters DscNodeConfigurationCreateOrUpdateParameters, options *DscNodeConfigurationClientBeginCreateOrUpdateOptions) (*runtime.Poller[DscNodeConfigurationClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create the node configuration identified by node configuration name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeConfigurationName - The Dsc node configuration name. parameters - The create or update parameters for configuration. options - DscNodeConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the DscNodeConfigurationClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateDscNodeConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount20",
		"configName.nodeConfigName",
		armautomation.DscNodeConfigurationCreateOrUpdateParameters{
			Name: to.Ptr("configName.nodeConfigName"),
			Properties: &armautomation.DscNodeConfigurationCreateOrUpdateParametersProperties{
				Configuration: &armautomation.DscConfigurationAssociationProperty{
					Name: to.Ptr("configName"),
				},
				IncrementNodeConfigurationBuild: to.Ptr(true),
				Source: &armautomation.ContentSource{
					Type: to.Ptr(armautomation.ContentSourceTypeEmbeddedContent),
					Hash: &armautomation.ContentHash{
						Algorithm: to.Ptr("sha256"),
						Value:     to.Ptr("6DE256A57F01BFA29B88696D5E77A383D6E61484C7686E8DB955FA10ACE9FFE5"),
					},
					Value:   to.Ptr("\r\ninstance of MSFT_RoleResource as $MSFT_RoleResource1ref\r\n{\r\nResourceID = \"[WindowsFeature]IIS\";\r\n Ensure = \"Present\";\r\n SourceInfo = \"::3::32::WindowsFeature\";\r\n Name = \"Web-Server\";\r\n ModuleName = \"PsDesiredStateConfiguration\";\r\n\r\nModuleVersion = \"1.0\";\r\r\n ConfigurationName = \"configName\";\r\r\n};\r\ninstance of OMI_ConfigurationDocument\r\n\r\r\n                    {\r\n Version=\"2.0.0\";\r\n \r\r\n                        MinimumCompatibleVersion = \"1.0.0\";\r\n \r\r\n                        CompatibleVersionAdditionalProperties= {\"Omi_BaseResource:ConfigurationName\"};\r\n \r\r\n                        Author=\"weijiel\";\r\n \r\r\n                        GenerationDate=\"03/30/2017 13:40:25\";\r\n \r\r\n                        GenerationHost=\"TEST-BACKEND\";\r\n \r\r\n                        Name=\"configName\";\r\n\r\r\n                    };\r\n"),
					Version: to.Ptr("1.0"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DscNodeConfigurationClient) Delete 

func (client *DscNodeConfigurationClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, nodeConfigurationName string, options *DscNodeConfigurationClientDeleteOptions) (DscNodeConfigurationClientDeleteResponse, error)

Delete - Delete the Dsc node configurations by node configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeConfigurationName - The Dsc node configuration name. options - DscNodeConfigurationClientDeleteOptions contains the optional parameters for the DscNodeConfigurationClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteDscNodeConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount20",
		"configName.nodeConfigName",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DscNodeConfigurationClient) Get 

func (client *DscNodeConfigurationClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, nodeConfigurationName string, options *DscNodeConfigurationClientGetOptions) (DscNodeConfigurationClientGetResponse, error)

Get - Retrieve the Dsc node configurations by node configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeConfigurationName - The Dsc node configuration name. options - DscNodeConfigurationClientGetOptions contains the optional parameters for the DscNodeConfigurationClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getDscNodeConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"SetupServer.localhost",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DscNodeConfigurationClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *DscNodeConfigurationClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *DscNodeConfigurationClientListByAutomationAccountOptions) *runtime.Pager[DscNodeConfigurationClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of dsc node configurations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - DscNodeConfigurationClientListByAutomationAccountOptions contains the optional parameters for the DscNodeConfigurationClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listDscNodeConfigurations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewDscNodeConfigurationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		&armautomation.DscNodeConfigurationClientListByAutomationAccountOptions{Filter: nil,
			Skip:        nil,
			Top:         nil,
			Inlinecount: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type DscNodeConfigurationClientBeginCreateOrUpdateOptions added in v0.3.0 

type DscNodeConfigurationClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DscNodeConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the DscNodeConfigurationClient.BeginCreateOrUpdate method.

type DscNodeConfigurationClientCreateOrUpdateResponse added in v0.3.0 

type DscNodeConfigurationClientCreateOrUpdateResponse struct {
	DscNodeConfiguration
}

DscNodeConfigurationClientCreateOrUpdateResponse contains the response from method DscNodeConfigurationClient.CreateOrUpdate.

type DscNodeConfigurationClientDeleteOptions added in v0.3.0 

type DscNodeConfigurationClientDeleteOptions struct {
}

DscNodeConfigurationClientDeleteOptions contains the optional parameters for the DscNodeConfigurationClient.Delete method.

type DscNodeConfigurationClientDeleteResponse added in v0.3.0 

type DscNodeConfigurationClientDeleteResponse struct {
}

DscNodeConfigurationClientDeleteResponse contains the response from method DscNodeConfigurationClient.Delete.

type DscNodeConfigurationClientGetOptions added in v0.3.0 

type DscNodeConfigurationClientGetOptions struct {
}

DscNodeConfigurationClientGetOptions contains the optional parameters for the DscNodeConfigurationClient.Get method.

type DscNodeConfigurationClientGetResponse added in v0.3.0 

type DscNodeConfigurationClientGetResponse struct {
	DscNodeConfiguration
}

DscNodeConfigurationClientGetResponse contains the response from method DscNodeConfigurationClient.Get.

type DscNodeConfigurationClientListByAutomationAccountOptions added in v0.3.0 

type DscNodeConfigurationClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
	// Return total rows.
	Inlinecount *string
	// The number of rows to skip.
	Skip *int32
	// The number of rows to take.
	Top *int32
}

DscNodeConfigurationClientListByAutomationAccountOptions contains the optional parameters for the DscNodeConfigurationClient.ListByAutomationAccount method.

type DscNodeConfigurationClientListByAutomationAccountResponse added in v0.3.0 

type DscNodeConfigurationClientListByAutomationAccountResponse struct {
	DscNodeConfigurationListResult
}

DscNodeConfigurationClientListByAutomationAccountResponse contains the response from method DscNodeConfigurationClient.ListByAutomationAccount.

type DscNodeConfigurationCreateOrUpdateParameters 

type DscNodeConfigurationCreateOrUpdateParameters struct {
	// Name of the node configuration.
	Name *string `json:"name,omitempty"`

	// Node configuration properties
	Properties *DscNodeConfigurationCreateOrUpdateParametersProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

DscNodeConfigurationCreateOrUpdateParameters - The parameters supplied to the create or update node configuration operation.

func (DscNodeConfigurationCreateOrUpdateParameters) MarshalJSON 

func (d DscNodeConfigurationCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscNodeConfigurationCreateOrUpdateParameters.

type DscNodeConfigurationCreateOrUpdateParametersProperties 

type DscNodeConfigurationCreateOrUpdateParametersProperties struct {
	// REQUIRED; Gets or sets the configuration of the node.
	Configuration *DscConfigurationAssociationProperty `json:"configuration,omitempty"`

	// REQUIRED; Gets or sets the source.
	Source *ContentSource `json:"source,omitempty"`

	// If a new build version of NodeConfiguration is required.
	IncrementNodeConfigurationBuild *bool `json:"incrementNodeConfigurationBuild,omitempty"`
}

DscNodeConfigurationCreateOrUpdateParametersProperties - The parameter properties supplied to the create or update node configuration operation.

type DscNodeConfigurationListResult 

type DscNodeConfigurationListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets the total rows in query.
	TotalCount *int32 `json:"totalCount,omitempty"`

	// Gets or sets a list of Dsc node configurations.
	Value []*DscNodeConfiguration `json:"value,omitempty"`
}

DscNodeConfigurationListResult - The response model for the list job operation.

type DscNodeConfigurationProperties 

type DscNodeConfigurationProperties struct {
	// Gets or sets the configuration of the node.
	Configuration *DscConfigurationAssociationProperty `json:"configuration,omitempty"`

	// Gets or sets creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// If a new build version of NodeConfiguration is required.
	IncrementNodeConfigurationBuild *bool `json:"incrementNodeConfigurationBuild,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Number of nodes with this node configuration assigned
	NodeCount *int64 `json:"nodeCount,omitempty"`

	// Source of node configuration.
	Source *string `json:"source,omitempty"`
}

DscNodeConfigurationProperties - Properties for the DscNodeConfiguration

func (DscNodeConfigurationProperties) MarshalJSON 

func (d DscNodeConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscNodeConfigurationProperties.

func (*DscNodeConfigurationProperties) UnmarshalJSON 

func (d *DscNodeConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscNodeConfigurationProperties.

type DscNodeExtensionHandlerAssociationProperty 

type DscNodeExtensionHandlerAssociationProperty struct {
	// Gets or sets the name of the extension handler.
	Name *string `json:"name,omitempty"`

	// Gets or sets the version of the extension handler.
	Version *string `json:"version,omitempty"`
}

DscNodeExtensionHandlerAssociationProperty - The dsc extensionHandler property associated with the node

type DscNodeListResult 

type DscNodeListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets the total number of nodes matching filter criteria.
	TotalCount *int32 `json:"totalCount,omitempty"`

	// Gets or sets a list of dsc nodes.
	Value []*DscNode `json:"value,omitempty"`
}

DscNodeListResult - The response model for the list dsc nodes operation.

type DscNodeProperties 

type DscNodeProperties struct {
	// Gets or sets the account id of the node.
	AccountID *string `json:"accountId,omitempty"`

	// Gets or sets the etag of the resource.
	Etag *string `json:"etag,omitempty"`

	// Gets or sets the list of extensionHandler properties for a Node.
	ExtensionHandler []*DscNodeExtensionHandlerAssociationProperty `json:"extensionHandler,omitempty"`

	// Gets or sets the ip of the node.
	IP *string `json:"ip,omitempty"`

	// Gets or sets the last seen time of the node.
	LastSeen *time.Time `json:"lastSeen,omitempty"`

	// Gets or sets the configuration of the node.
	NodeConfiguration *DscNodeConfigurationAssociationProperty `json:"nodeConfiguration,omitempty"`

	// Gets or sets the node id.
	NodeID *string `json:"nodeId,omitempty"`

	// Gets or sets the registration time of the node.
	RegistrationTime *time.Time `json:"registrationTime,omitempty"`

	// Gets or sets the status of the node.
	Status *string `json:"status,omitempty"`

	// Gets the total number of records matching filter criteria.
	TotalCount *int32 `json:"totalCount,omitempty"`
}

DscNodeProperties - The properties of a DscNode

func (DscNodeProperties) MarshalJSON 

func (d DscNodeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscNodeProperties.

func (*DscNodeProperties) UnmarshalJSON 

func (d *DscNodeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscNodeProperties.

type DscNodeReport 

type DscNodeReport struct {
	// Gets or sets the configurationVersion of the node report.
	ConfigurationVersion *string `json:"configurationVersion,omitempty"`

	// Gets or sets the end time of the node report.
	EndTime *time.Time `json:"endTime,omitempty"`

	// Gets or sets the errors for the node report.
	Errors []*DscReportError `json:"errors,omitempty"`

	// Gets or sets the hostname of the node that sent the report.
	HostName *string `json:"hostName,omitempty"`

	// Gets or sets the id.
	ID *string `json:"id,omitempty"`

	// Gets or sets the IPv4 address of the node that sent the report.
	IPV4Addresses []*string `json:"iPV4Addresses,omitempty"`

	// Gets or sets the IPv6 address of the node that sent the report.
	IPV6Addresses []*string `json:"iPV6Addresses,omitempty"`

	// Gets or sets the lastModifiedTime of the node report.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the metaConfiguration of the node at the time of the report.
	MetaConfiguration *DscMetaConfiguration `json:"metaConfiguration,omitempty"`

	// Gets or sets the number of resource in the node report.
	NumberOfResources *int32 `json:"numberOfResources,omitempty"`

	// Gets or sets the unparsed errors for the node report.
	RawErrors *string `json:"rawErrors,omitempty"`

	// Gets or sets the rebootRequested of the node report.
	RebootRequested *string `json:"rebootRequested,omitempty"`

	// Gets or sets the refreshMode of the node report.
	RefreshMode *string `json:"refreshMode,omitempty"`

	// Gets or sets the reportFormatVersion of the node report.
	ReportFormatVersion *string `json:"reportFormatVersion,omitempty"`

	// Gets or sets the id of the node report.
	ReportID *string `json:"reportId,omitempty"`

	// Gets or sets the resource for the node report.
	Resources []*DscReportResource `json:"resources,omitempty"`

	// Gets or sets the start time of the node report.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Gets or sets the status of the node report.
	Status *string `json:"status,omitempty"`

	// Gets or sets the type of the node report.
	Type *string `json:"type,omitempty"`
}

DscNodeReport - Definition of the dsc node report type.

func (*DscNodeReport) UnmarshalJSON 

func (d *DscNodeReport) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscNodeReport.

type DscNodeReportListResult 

type DscNodeReportListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of dsc node reports.
	Value []*DscNodeReport `json:"value,omitempty"`
}

DscNodeReportListResult - The response model for the list dsc nodes operation.

type DscNodeUpdateParameters 

type DscNodeUpdateParameters struct {
	// Gets or sets the id of the dsc node.
	NodeID     *string                            `json:"nodeId,omitempty"`
	Properties *DscNodeUpdateParametersProperties `json:"properties,omitempty"`
}

DscNodeUpdateParameters - The parameters supplied to the update dsc node operation.

func (DscNodeUpdateParameters) MarshalJSON 

func (d DscNodeUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscNodeUpdateParameters.

type DscNodeUpdateParametersProperties 

type DscNodeUpdateParametersProperties struct {
	// Gets or sets the configuration of the node.
	NodeConfiguration *DscNodeConfigurationAssociationProperty `json:"nodeConfiguration,omitempty"`
}

type DscReportError 

type DscReportError struct {
	// Gets or sets the error code.
	ErrorCode *string `json:"errorCode,omitempty"`

	// Gets or sets the error details.
	ErrorDetails *string `json:"errorDetails,omitempty"`

	// Gets or sets the error message.
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Gets or sets the source of the error.
	ErrorSource *string `json:"errorSource,omitempty"`

	// Gets or sets the locale of the error.
	Locale *string `json:"locale,omitempty"`

	// Gets or sets the resource ID which generated the error.
	ResourceID *string `json:"resourceId,omitempty"`
}

DscReportError - Definition of the dsc node report error type.

type DscReportResource 

type DscReportResource struct {
	// Gets or sets the Resource Navigation values for resources the resource depends on.
	DependsOn []*DscReportResourceNavigation `json:"dependsOn,omitempty"`

	// Gets or sets the duration in seconds for the resource.
	DurationInSeconds *float64 `json:"durationInSeconds,omitempty"`

	// Gets or sets the error of the resource.
	Error *string `json:"error,omitempty"`

	// Gets or sets the module name of the resource.
	ModuleName *string `json:"moduleName,omitempty"`

	// Gets or sets the module version of the resource.
	ModuleVersion *string `json:"moduleVersion,omitempty"`

	// Gets or sets the ID of the resource.
	ResourceID *string `json:"resourceId,omitempty"`

	// Gets or sets the name of the resource.
	ResourceName *string `json:"resourceName,omitempty"`

	// Gets or sets the source info of the resource.
	SourceInfo *string `json:"sourceInfo,omitempty"`

	// Gets or sets the start date of the resource.
	StartDate *time.Time `json:"startDate,omitempty"`

	// Gets or sets the status of the resource.
	Status *string `json:"status,omitempty"`
}

DscReportResource - Definition of the DSC Report Resource.

func (*DscReportResource) UnmarshalJSON 

func (d *DscReportResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscReportResource.

type DscReportResourceNavigation 

type DscReportResourceNavigation struct {
	// Gets or sets the ID of the resource to navigate to.
	ResourceID *string `json:"resourceId,omitempty"`
}

DscReportResourceNavigation - Navigation for DSC Report Resource.

type EncryptionKeySourceType 

type EncryptionKeySourceType string

EncryptionKeySourceType - Encryption Key Source 

const (
	EncryptionKeySourceTypeMicrosoftAutomation EncryptionKeySourceType = "Microsoft.Automation"
	EncryptionKeySourceTypeMicrosoftKeyvault   EncryptionKeySourceType = "Microsoft.Keyvault"
)

func PossibleEncryptionKeySourceTypeValues 

func PossibleEncryptionKeySourceTypeValues() []EncryptionKeySourceType

PossibleEncryptionKeySourceTypeValues returns the possible values for the EncryptionKeySourceType const type.

type EncryptionProperties 

type EncryptionProperties struct {
	// User identity used for CMK.
	Identity *EncryptionPropertiesIdentity `json:"identity,omitempty"`

	// Encryption Key Source
	KeySource *EncryptionKeySourceType `json:"keySource,omitempty"`

	// Key vault properties.
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

EncryptionProperties - The encryption settings for automation account

type EncryptionPropertiesIdentity 

type EncryptionPropertiesIdentity struct {
	// The user identity used for CMK. It will be an ARM resource id in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentity interface{} `json:"userAssignedIdentity,omitempty"`
}

EncryptionPropertiesIdentity - User identity used for CMK.

type ErrorResponse 

type ErrorResponse struct {
	// Error code
	Code *string `json:"code,omitempty"`

	// Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse - Error response of an operation failure

type FieldDefinition 

type FieldDefinition struct {
	// REQUIRED; Gets or sets the type of the connection field definition.
	Type *string `json:"type,omitempty"`

	// Gets or sets the isEncrypted flag of the connection field definition.
	IsEncrypted *bool `json:"isEncrypted,omitempty"`

	// Gets or sets the isOptional flag of the connection field definition.
	IsOptional *bool `json:"isOptional,omitempty"`
}

FieldDefinition - Definition of the connection fields.

type FieldsClient 

type FieldsClient struct {
	// contains filtered or unexported fields
}

FieldsClient contains the methods for the Fields group. Don't use this type directly, use NewFieldsClient() instead.

func NewFieldsClient 

func NewFieldsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FieldsClient, error)

NewFieldsClient creates a new instance of FieldsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FieldsClient) NewListByTypePager added in v0.5.0 

func (client *FieldsClient) NewListByTypePager(resourceGroupName string, automationAccountName string, moduleName string, typeName string, options *FieldsClientListByTypeOptions) *runtime.Pager[FieldsClientListByTypeResponse]

NewListByTypePager - Retrieve a list of fields of a given type identified by module name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The name of module. typeName - The name of type. options - FieldsClientListByTypeOptions contains the optional parameters for the FieldsClient.ListByType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listFieldsByModuleAndType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewFieldsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByTypePager("rg",
		"MyAutomationAccount",
		"MyModule",
		"MyCustomType",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type FieldsClientListByTypeOptions added in v0.3.0 

type FieldsClientListByTypeOptions struct {
}

FieldsClientListByTypeOptions contains the optional parameters for the FieldsClient.ListByType method.

type FieldsClientListByTypeResponse added in v0.3.0 

type FieldsClientListByTypeResponse struct {
	TypeFieldListResult
}

FieldsClientListByTypeResponse contains the response from method FieldsClient.ListByType.

type GraphRunbookType 

type GraphRunbookType string

GraphRunbookType - Runbook Type 

const (
	GraphRunbookTypeGraphPowerShell         GraphRunbookType = "GraphPowerShell"
	GraphRunbookTypeGraphPowerShellWorkflow GraphRunbookType = "GraphPowerShellWorkflow"
)

func PossibleGraphRunbookTypeValues 

func PossibleGraphRunbookTypeValues() []GraphRunbookType

PossibleGraphRunbookTypeValues returns the possible values for the GraphRunbookType const type.

type GraphicalRunbookContent 

type GraphicalRunbookContent struct {
	// Graphical Runbook content as JSON
	GraphRunbookJSON *string `json:"graphRunbookJson,omitempty"`

	// Raw graphical Runbook content.
	RawContent *RawGraphicalRunbookContent `json:"rawContent,omitempty"`
}

GraphicalRunbookContent - Graphical Runbook Content

type GroupTypeEnum 

type GroupTypeEnum string

GroupTypeEnum - Type of the HybridWorkerGroup. 

const (
	GroupTypeEnumSystem GroupTypeEnum = "System"
	GroupTypeEnumUser   GroupTypeEnum = "User"
)

func PossibleGroupTypeEnumValues 

func PossibleGroupTypeEnumValues() []GroupTypeEnum

PossibleGroupTypeEnumValues returns the possible values for the GroupTypeEnum const type.

type HTTPStatusCode 

type HTTPStatusCode string
const (
	HTTPStatusCodeAccepted                     HTTPStatusCode = "Accepted"
	HTTPStatusCodeAmbiguous                    HTTPStatusCode = "Ambiguous"
	HTTPStatusCodeBadGateway                   HTTPStatusCode = "BadGateway"
	HTTPStatusCodeBadRequest                   HTTPStatusCode = "BadRequest"
	HTTPStatusCodeConflict                     HTTPStatusCode = "Conflict"
	HTTPStatusCodeContinue                     HTTPStatusCode = "Continue"
	HTTPStatusCodeCreated                      HTTPStatusCode = "Created"
	HTTPStatusCodeExpectationFailed            HTTPStatusCode = "ExpectationFailed"
	HTTPStatusCodeForbidden                    HTTPStatusCode = "Forbidden"
	HTTPStatusCodeFound                        HTTPStatusCode = "Found"
	HTTPStatusCodeGatewayTimeout               HTTPStatusCode = "GatewayTimeout"
	HTTPStatusCodeGone                         HTTPStatusCode = "Gone"
	HTTPStatusCodeHTTPVersionNotSupported      HTTPStatusCode = "HttpVersionNotSupported"
	HTTPStatusCodeInternalServerError          HTTPStatusCode = "InternalServerError"
	HTTPStatusCodeLengthRequired               HTTPStatusCode = "LengthRequired"
	HTTPStatusCodeMethodNotAllowed             HTTPStatusCode = "MethodNotAllowed"
	HTTPStatusCodeMoved                        HTTPStatusCode = "Moved"
	HTTPStatusCodeMovedPermanently             HTTPStatusCode = "MovedPermanently"
	HTTPStatusCodeMultipleChoices              HTTPStatusCode = "MultipleChoices"
	HTTPStatusCodeNoContent                    HTTPStatusCode = "NoContent"
	HTTPStatusCodeNonAuthoritativeInformation  HTTPStatusCode = "NonAuthoritativeInformation"
	HTTPStatusCodeNotAcceptable                HTTPStatusCode = "NotAcceptable"
	HTTPStatusCodeNotFound                     HTTPStatusCode = "NotFound"
	HTTPStatusCodeNotImplemented               HTTPStatusCode = "NotImplemented"
	HTTPStatusCodeNotModified                  HTTPStatusCode = "NotModified"
	HTTPStatusCodeOK                           HTTPStatusCode = "OK"
	HTTPStatusCodePartialContent               HTTPStatusCode = "PartialContent"
	HTTPStatusCodePaymentRequired              HTTPStatusCode = "PaymentRequired"
	HTTPStatusCodePreconditionFailed           HTTPStatusCode = "PreconditionFailed"
	HTTPStatusCodeProxyAuthenticationRequired  HTTPStatusCode = "ProxyAuthenticationRequired"
	HTTPStatusCodeRedirect                     HTTPStatusCode = "Redirect"
	HTTPStatusCodeRedirectKeepVerb             HTTPStatusCode = "RedirectKeepVerb"
	HTTPStatusCodeRedirectMethod               HTTPStatusCode = "RedirectMethod"
	HTTPStatusCodeRequestEntityTooLarge        HTTPStatusCode = "RequestEntityTooLarge"
	HTTPStatusCodeRequestTimeout               HTTPStatusCode = "RequestTimeout"
	HTTPStatusCodeRequestURITooLong            HTTPStatusCode = "RequestUriTooLong"
	HTTPStatusCodeRequestedRangeNotSatisfiable HTTPStatusCode = "RequestedRangeNotSatisfiable"
	HTTPStatusCodeResetContent                 HTTPStatusCode = "ResetContent"
	HTTPStatusCodeSeeOther                     HTTPStatusCode = "SeeOther"
	HTTPStatusCodeServiceUnavailable           HTTPStatusCode = "ServiceUnavailable"
	HTTPStatusCodeSwitchingProtocols           HTTPStatusCode = "SwitchingProtocols"
	HTTPStatusCodeTemporaryRedirect            HTTPStatusCode = "TemporaryRedirect"
	HTTPStatusCodeUnauthorized                 HTTPStatusCode = "Unauthorized"
	HTTPStatusCodeUnsupportedMediaType         HTTPStatusCode = "UnsupportedMediaType"
	HTTPStatusCodeUnused                       HTTPStatusCode = "Unused"
	HTTPStatusCodeUpgradeRequired              HTTPStatusCode = "UpgradeRequired"
	HTTPStatusCodeUseProxy                     HTTPStatusCode = "UseProxy"
)

func PossibleHTTPStatusCodeValues 

func PossibleHTTPStatusCodeValues() []HTTPStatusCode

PossibleHTTPStatusCodeValues returns the possible values for the HTTPStatusCode const type.

type HybridRunbookWorker 

type HybridRunbookWorker struct {
	// Gets or sets the hybrid worker group properties.
	Properties *HybridRunbookWorkerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource system metadata.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

HybridRunbookWorker - Definition of hybrid runbook worker.

type HybridRunbookWorkerCreateOrUpdateParameters 

type HybridRunbookWorkerCreateOrUpdateParameters struct {
	// Azure Resource Manager Id for a virtual machine.
	VMResourceID *string `json:"vmResourceId,omitempty"`
}

HybridRunbookWorkerCreateOrUpdateParameters - The parameters supplied to the create or update hybrid runbook worker operation.

type HybridRunbookWorkerCreateParameters 

type HybridRunbookWorkerCreateParameters struct {
	// REQUIRED; Gets or sets hybrid runbook worker group create or update properties.
	Properties *HybridRunbookWorkerCreateOrUpdateParameters `json:"properties,omitempty"`

	// Gets or sets the name of the resource.
	Name *string `json:"name,omitempty"`
}

HybridRunbookWorkerCreateParameters - The parameters supplied to the create hybrid runbook worker operation.

type HybridRunbookWorkerGroup 

type HybridRunbookWorkerGroup struct {
	// Sets the credential of a worker group.
	Credential *RunAsCredentialAssociationProperty `json:"credential,omitempty"`

	// Type of the HybridWorkerGroup.
	GroupType *GroupTypeEnum `json:"groupType,omitempty"`

	// Gets or sets the list of hybrid runbook workers.
	HybridRunbookWorkers []*HybridRunbookWorkerLegacy `json:"hybridRunbookWorkers,omitempty"`

	// Gets or sets the id of the resource.
	ID *string `json:"id,omitempty"`

	// Gets or sets the name of the group.
	Name *string `json:"name,omitempty"`

	// READ-ONLY; Resource system metadata.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

HybridRunbookWorkerGroup - Definition of hybrid runbook worker group.

type HybridRunbookWorkerGroupClient 

type HybridRunbookWorkerGroupClient struct {
	// contains filtered or unexported fields
}

HybridRunbookWorkerGroupClient contains the methods for the HybridRunbookWorkerGroup group. Don't use this type directly, use NewHybridRunbookWorkerGroupClient() instead.

func NewHybridRunbookWorkerGroupClient 

func NewHybridRunbookWorkerGroupClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*HybridRunbookWorkerGroupClient, error)

NewHybridRunbookWorkerGroupClient creates a new instance of HybridRunbookWorkerGroupClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*HybridRunbookWorkerGroupClient) Create 

func (client *HybridRunbookWorkerGroupClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, hybridRunbookWorkerGroupCreationParameters HybridRunbookWorkerGroupCreateOrUpdateParameters, options *HybridRunbookWorkerGroupClientCreateOptions) (HybridRunbookWorkerGroupClientCreateResponse, error)

Create - Create a hybrid runbook worker group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name hybridRunbookWorkerGroupCreationParameters - The create or update parameters for hybrid runbook worker group. options - HybridRunbookWorkerGroupClientCreateOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/putHybridRunbookWorkerGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkerGroupClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"rg",
		"testaccount",
		"TestHybridGroup",
		armautomation.HybridRunbookWorkerGroupCreateOrUpdateParameters{
			Credential: &armautomation.RunAsCredentialAssociationProperty{
				Name: to.Ptr("myRunAsCredentialName"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*HybridRunbookWorkerGroupClient) Delete 

func (client *HybridRunbookWorkerGroupClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, options *HybridRunbookWorkerGroupClientDeleteOptions) (HybridRunbookWorkerGroupClientDeleteResponse, error)

Delete - Delete a hybrid runbook worker group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name options - HybridRunbookWorkerGroupClientDeleteOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/deleteHybridRunbookWorkerGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkerGroupClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount20",
		"myGroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*HybridRunbookWorkerGroupClient) Get 

func (client *HybridRunbookWorkerGroupClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, options *HybridRunbookWorkerGroupClientGetOptions) (HybridRunbookWorkerGroupClientGetResponse, error)

Get - Retrieve a hybrid runbook worker group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name options - HybridRunbookWorkerGroupClientGetOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getHybridRunbookWorkerGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkerGroupClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"testaccount",
		"TestHybridGroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*HybridRunbookWorkerGroupClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *HybridRunbookWorkerGroupClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *HybridRunbookWorkerGroupClientListByAutomationAccountOptions) *runtime.Pager[HybridRunbookWorkerGroupClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of hybrid runbook worker groups. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - HybridRunbookWorkerGroupClientListByAutomationAccountOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/listHybridRunbookWorkerGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkerGroupClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"testaccount",
		&armautomation.HybridRunbookWorkerGroupClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*HybridRunbookWorkerGroupClient) Update 

func (client *HybridRunbookWorkerGroupClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, parameters HybridRunbookWorkerGroupCreateOrUpdateParameters, options *HybridRunbookWorkerGroupClientUpdateOptions) (HybridRunbookWorkerGroupClientUpdateResponse, error)

Update - Update a hybrid runbook worker group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name parameters - The hybrid runbook worker group options - HybridRunbookWorkerGroupClientUpdateOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/updateHybridRunbookWorkerGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkerGroupClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"testaccount",
		"TestHybridGroup",
		armautomation.HybridRunbookWorkerGroupCreateOrUpdateParameters{
			Credential: &armautomation.RunAsCredentialAssociationProperty{
				Name: to.Ptr("myRunAsCredentialName"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type HybridRunbookWorkerGroupClientCreateOptions added in v0.3.0 

type HybridRunbookWorkerGroupClientCreateOptions struct {
}

HybridRunbookWorkerGroupClientCreateOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Create method.

type HybridRunbookWorkerGroupClientCreateResponse added in v0.3.0 

type HybridRunbookWorkerGroupClientCreateResponse struct {
	HybridRunbookWorkerGroup
}

HybridRunbookWorkerGroupClientCreateResponse contains the response from method HybridRunbookWorkerGroupClient.Create.

type HybridRunbookWorkerGroupClientDeleteOptions added in v0.3.0 

type HybridRunbookWorkerGroupClientDeleteOptions struct {
}

HybridRunbookWorkerGroupClientDeleteOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Delete method.

type HybridRunbookWorkerGroupClientDeleteResponse added in v0.3.0 

type HybridRunbookWorkerGroupClientDeleteResponse struct {
}

HybridRunbookWorkerGroupClientDeleteResponse contains the response from method HybridRunbookWorkerGroupClient.Delete.

type HybridRunbookWorkerGroupClientGetOptions added in v0.3.0 

type HybridRunbookWorkerGroupClientGetOptions struct {
}

HybridRunbookWorkerGroupClientGetOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Get method.

type HybridRunbookWorkerGroupClientGetResponse added in v0.3.0 

type HybridRunbookWorkerGroupClientGetResponse struct {
	HybridRunbookWorkerGroup
}

HybridRunbookWorkerGroupClientGetResponse contains the response from method HybridRunbookWorkerGroupClient.Get.

type HybridRunbookWorkerGroupClientListByAutomationAccountOptions added in v0.3.0 

type HybridRunbookWorkerGroupClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

HybridRunbookWorkerGroupClientListByAutomationAccountOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.ListByAutomationAccount method.

type HybridRunbookWorkerGroupClientListByAutomationAccountResponse added in v0.3.0 

type HybridRunbookWorkerGroupClientListByAutomationAccountResponse struct {
	HybridRunbookWorkerGroupsListResult
}

HybridRunbookWorkerGroupClientListByAutomationAccountResponse contains the response from method HybridRunbookWorkerGroupClient.ListByAutomationAccount.

type HybridRunbookWorkerGroupClientUpdateOptions added in v0.3.0 

type HybridRunbookWorkerGroupClientUpdateOptions struct {
}

HybridRunbookWorkerGroupClientUpdateOptions contains the optional parameters for the HybridRunbookWorkerGroupClient.Update method.

type HybridRunbookWorkerGroupClientUpdateResponse added in v0.3.0 

type HybridRunbookWorkerGroupClientUpdateResponse struct {
	HybridRunbookWorkerGroup
}

HybridRunbookWorkerGroupClientUpdateResponse contains the response from method HybridRunbookWorkerGroupClient.Update.

type HybridRunbookWorkerGroupCreateOrUpdateParameters 

type HybridRunbookWorkerGroupCreateOrUpdateParameters struct {
	// Sets the credential of a worker group.
	Credential *RunAsCredentialAssociationProperty `json:"credential,omitempty"`
}

HybridRunbookWorkerGroupCreateOrUpdateParameters - The parameters supplied to the create or update hybrid runbook worker group operation.

func (HybridRunbookWorkerGroupCreateOrUpdateParameters) MarshalJSON 

func (h HybridRunbookWorkerGroupCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HybridRunbookWorkerGroupCreateOrUpdateParameters.

type HybridRunbookWorkerGroupUpdateParameters 

type HybridRunbookWorkerGroupUpdateParameters struct {
	// Sets the credential of a worker group.
	Credential *RunAsCredentialAssociationProperty `json:"credential,omitempty"`
}

HybridRunbookWorkerGroupUpdateParameters - Parameters supplied to the update operation.

type HybridRunbookWorkerGroupsListResult 

type HybridRunbookWorkerGroupsListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of hybrid runbook worker groups.
	Value []*HybridRunbookWorkerGroup `json:"value,omitempty"`
}

HybridRunbookWorkerGroupsListResult - The response model for the list hybrid runbook worker groups.

type HybridRunbookWorkerLegacy 

type HybridRunbookWorkerLegacy struct {
	// Gets or sets the assigned machine IP address.
	IP *string `json:"ip,omitempty"`

	// Last Heartbeat from the Worker
	LastSeenDateTime *time.Time `json:"lastSeenDateTime,omitempty"`

	// Gets or sets the worker machine name.
	Name *string `json:"name,omitempty"`

	// Gets or sets the registration time of the worker machine.
	RegistrationTime *time.Time `json:"registrationTime,omitempty"`
}

HybridRunbookWorkerLegacy - Definition of hybrid runbook worker Legacy.

func (*HybridRunbookWorkerLegacy) UnmarshalJSON 

func (h *HybridRunbookWorkerLegacy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HybridRunbookWorkerLegacy.

type HybridRunbookWorkerMoveParameters 

type HybridRunbookWorkerMoveParameters struct {
	// Gets or sets the target hybrid runbook worker group.
	HybridRunbookWorkerGroupName *string `json:"hybridRunbookWorkerGroupName,omitempty"`
}

HybridRunbookWorkerMoveParameters - Parameters supplied to move hybrid worker operation.

type HybridRunbookWorkerProperties 

type HybridRunbookWorkerProperties struct {
	// Gets or sets the assigned machine IP address.
	IP *string `json:"ip,omitempty"`

	// Last Heartbeat from the Worker
	LastSeenDateTime *time.Time `json:"lastSeenDateTime,omitempty"`

	// Gets or sets the registration time of the worker machine.
	RegisteredDateTime *time.Time `json:"registeredDateTime,omitempty"`

	// Azure Resource Manager Id for a virtual machine.
	VMResourceID *string `json:"vmResourceId,omitempty"`

	// Name of the HybridWorker.
	WorkerName *string `json:"workerName,omitempty"`

	// Type of the HybridWorker.
	WorkerType *WorkerType `json:"workerType,omitempty"`
}

HybridRunbookWorkerProperties - Definition of hybrid runbook worker property.

func (HybridRunbookWorkerProperties) MarshalJSON 

func (h HybridRunbookWorkerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HybridRunbookWorkerProperties.

func (*HybridRunbookWorkerProperties) UnmarshalJSON 

func (h *HybridRunbookWorkerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HybridRunbookWorkerProperties.

type HybridRunbookWorkersClient 

type HybridRunbookWorkersClient struct {
	// contains filtered or unexported fields
}

HybridRunbookWorkersClient contains the methods for the HybridRunbookWorkers group. Don't use this type directly, use NewHybridRunbookWorkersClient() instead.

func NewHybridRunbookWorkersClient 

func NewHybridRunbookWorkersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*HybridRunbookWorkersClient, error)

NewHybridRunbookWorkersClient creates a new instance of HybridRunbookWorkersClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*HybridRunbookWorkersClient) Create 

func (client *HybridRunbookWorkersClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, hybridRunbookWorkerID string, hybridRunbookWorkerCreationParameters HybridRunbookWorkerCreateParameters, options *HybridRunbookWorkersClientCreateOptions) (HybridRunbookWorkersClientCreateResponse, error)

Create - Create a hybrid runbook worker. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name hybridRunbookWorkerID - The hybrid runbook worker id hybridRunbookWorkerCreationParameters - The create or update parameters for hybrid runbook worker. options - HybridRunbookWorkersClientCreateOptions contains the optional parameters for the HybridRunbookWorkersClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/putHybridRunbookWorker.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"rg",
		"testaccount",
		"TestHybridGroup",
		"c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
		armautomation.HybridRunbookWorkerCreateParameters{
			Properties: &armautomation.HybridRunbookWorkerCreateOrUpdateParameters{
				VMResourceID: to.Ptr("/subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*HybridRunbookWorkersClient) Delete 

func (client *HybridRunbookWorkersClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, hybridRunbookWorkerID string, options *HybridRunbookWorkersClientDeleteOptions) (HybridRunbookWorkersClientDeleteResponse, error)

Delete - Delete a hybrid runbook worker. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name hybridRunbookWorkerID - The hybrid runbook worker id options - HybridRunbookWorkersClientDeleteOptions contains the optional parameters for the HybridRunbookWorkersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/deleteHybridRunbookWorker.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount20",
		"myGroup",
		"c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*HybridRunbookWorkersClient) Get 

func (client *HybridRunbookWorkersClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, hybridRunbookWorkerID string, options *HybridRunbookWorkersClientGetOptions) (HybridRunbookWorkersClientGetResponse, error)

Get - Retrieve a hybrid runbook worker. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name hybridRunbookWorkerID - The hybrid runbook worker id options - HybridRunbookWorkersClientGetOptions contains the optional parameters for the HybridRunbookWorkersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getHybridRunbookWorker.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"testaccount",
		"TestHybridGroup",
		"c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*HybridRunbookWorkersClient) Move 

func (client *HybridRunbookWorkersClient) Move(ctx context.Context, resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, hybridRunbookWorkerID string, hybridRunbookWorkerMoveParameters HybridRunbookWorkerMoveParameters, options *HybridRunbookWorkersClientMoveOptions) (HybridRunbookWorkersClientMoveResponse, error)

Move - Move a hybrid worker to a different group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name hybridRunbookWorkerID - The hybrid runbook worker id hybridRunbookWorkerMoveParameters - The hybrid runbook worker move parameters options - HybridRunbookWorkersClientMoveOptions contains the optional parameters for the HybridRunbookWorkersClient.Move method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/moveHybridRunbookWorker.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Move(ctx,
		"rg",
		"testaccount",
		"TestHybridGroup",
		"c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
		armautomation.HybridRunbookWorkerMoveParameters{
			HybridRunbookWorkerGroupName: to.Ptr("TestHybridGroup2"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*HybridRunbookWorkersClient) NewListByHybridRunbookWorkerGroupPager added in v0.5.0 

func (client *HybridRunbookWorkersClient) NewListByHybridRunbookWorkerGroupPager(resourceGroupName string, automationAccountName string, hybridRunbookWorkerGroupName string, options *HybridRunbookWorkersClientListByHybridRunbookWorkerGroupOptions) *runtime.Pager[HybridRunbookWorkersClientListByHybridRunbookWorkerGroupResponse]

NewListByHybridRunbookWorkerGroupPager - Retrieve a list of hybrid runbook workers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. hybridRunbookWorkerGroupName - The hybrid runbook worker group name options - HybridRunbookWorkersClientListByHybridRunbookWorkerGroupOptions contains the optional parameters for the HybridRunbookWorkersClient.ListByHybridRunbookWorkerGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/listHybridRunbookWorker.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewHybridRunbookWorkersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByHybridRunbookWorkerGroupPager("rg",
		"testaccount",
		"TestHybridGroup",
		&armautomation.HybridRunbookWorkersClientListByHybridRunbookWorkerGroupOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type HybridRunbookWorkersClientCreateOptions added in v0.3.0 

type HybridRunbookWorkersClientCreateOptions struct {
}

HybridRunbookWorkersClientCreateOptions contains the optional parameters for the HybridRunbookWorkersClient.Create method.

type HybridRunbookWorkersClientCreateResponse added in v0.3.0 

type HybridRunbookWorkersClientCreateResponse struct {
	HybridRunbookWorker
}

HybridRunbookWorkersClientCreateResponse contains the response from method HybridRunbookWorkersClient.Create.

type HybridRunbookWorkersClientDeleteOptions added in v0.3.0 

type HybridRunbookWorkersClientDeleteOptions struct {
}

HybridRunbookWorkersClientDeleteOptions contains the optional parameters for the HybridRunbookWorkersClient.Delete method.

type HybridRunbookWorkersClientDeleteResponse added in v0.3.0 

type HybridRunbookWorkersClientDeleteResponse struct {
}

HybridRunbookWorkersClientDeleteResponse contains the response from method HybridRunbookWorkersClient.Delete.

type HybridRunbookWorkersClientGetOptions added in v0.3.0 

type HybridRunbookWorkersClientGetOptions struct {
}

HybridRunbookWorkersClientGetOptions contains the optional parameters for the HybridRunbookWorkersClient.Get method.

type HybridRunbookWorkersClientGetResponse added in v0.3.0 

type HybridRunbookWorkersClientGetResponse struct {
	HybridRunbookWorker
}

HybridRunbookWorkersClientGetResponse contains the response from method HybridRunbookWorkersClient.Get.

type HybridRunbookWorkersClientListByHybridRunbookWorkerGroupOptions added in v0.3.0 

type HybridRunbookWorkersClientListByHybridRunbookWorkerGroupOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

HybridRunbookWorkersClientListByHybridRunbookWorkerGroupOptions contains the optional parameters for the HybridRunbookWorkersClient.ListByHybridRunbookWorkerGroup method.

type HybridRunbookWorkersClientListByHybridRunbookWorkerGroupResponse added in v0.3.0 

type HybridRunbookWorkersClientListByHybridRunbookWorkerGroupResponse struct {
	HybridRunbookWorkersListResult
}

HybridRunbookWorkersClientListByHybridRunbookWorkerGroupResponse contains the response from method HybridRunbookWorkersClient.ListByHybridRunbookWorkerGroup.

type HybridRunbookWorkersClientMoveOptions added in v0.3.0 

type HybridRunbookWorkersClientMoveOptions struct {
}

HybridRunbookWorkersClientMoveOptions contains the optional parameters for the HybridRunbookWorkersClient.Move method.

type HybridRunbookWorkersClientMoveResponse added in v0.3.0 

type HybridRunbookWorkersClientMoveResponse struct {
}

HybridRunbookWorkersClientMoveResponse contains the response from method HybridRunbookWorkersClient.Move.

type HybridRunbookWorkersListResult 

type HybridRunbookWorkersListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of hybrid runbook workers.
	Value []*HybridRunbookWorker `json:"value,omitempty"`
}

HybridRunbookWorkersListResult - The response model for the list hybrid runbook workers.

type Identity 

type Identity struct {
	// The identity type.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource
	// ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource.

func (Identity) MarshalJSON 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

type Job 

type Job struct {
	// The properties of the job.
	Properties *JobProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Job - Definition of the job.

type JobClient 

type JobClient struct {
	// contains filtered or unexported fields
}

JobClient contains the methods for the Job group. Don't use this type directly, use NewJobClient() instead.

func NewJobClient 

func NewJobClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobClient, error)

NewJobClient creates a new instance of JobClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*JobClient) Create 

func (client *JobClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, parameters JobCreateParameters, options *JobClientCreateOptions) (JobClientCreateResponse, error)

Create - Create a job of the runbook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. parameters - The parameters supplied to the create job operation. options - JobClientCreateOptions contains the optional parameters for the JobClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/createJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Create(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		armautomation.JobCreateParameters{
			Properties: &armautomation.JobCreateProperties{
				Parameters: map[string]*string{
					"key01": to.Ptr("value01"),
					"key02": to.Ptr("value02"),
				},
				RunOn: to.Ptr(""),
				Runbook: &armautomation.RunbookAssociationProperty{
					Name: to.Ptr("TestRunbook"),
				},
			},
		},
		&armautomation.JobClientCreateOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*JobClient) Get 

func (client *JobClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, options *JobClientGetOptions) (JobClientGetResponse, error)

Get - Retrieve the job identified by job name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. options - JobClientGetOptions contains the optional parameters for the JobClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/getJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobClientGetOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*JobClient) GetOutput 

func (client *JobClient) GetOutput(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, options *JobClientGetOutputOptions) (JobClientGetOutputResponse, error)

GetOutput - Retrieve the job output identified by job name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The name of the job to be created. options - JobClientGetOutputOptions contains the optional parameters for the JobClient.GetOutput method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/getJobOutput.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetOutput(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobClientGetOutputOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*JobClient) GetRunbookContent 

func (client *JobClient) GetRunbookContent(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, options *JobClientGetRunbookContentOptions) (JobClientGetRunbookContentResponse, error)

GetRunbookContent - Retrieve the runbook content of the job identified by job name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. options - JobClientGetRunbookContentOptions contains the optional parameters for the JobClient.GetRunbookContent method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/getJobRunbookContent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetRunbookContent(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobClientGetRunbookContentOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*JobClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *JobClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *JobClientListByAutomationAccountOptions) *runtime.Pager[JobClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of jobs. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - JobClientListByAutomationAccountOptions contains the optional parameters for the JobClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/listJobsByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("mygroup",
		"ContoseAutomationAccount",
		&armautomation.JobClientListByAutomationAccountOptions{Filter: nil,
			ClientRequestID: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*JobClient) Resume 

func (client *JobClient) Resume(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, options *JobClientResumeOptions) (JobClientResumeResponse, error)

Resume - Resume the job identified by jobName. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. options - JobClientResumeOptions contains the optional parameters for the JobClient.Resume method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/resumeJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Resume(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobClientResumeOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*JobClient) Stop 

func (client *JobClient) Stop(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, options *JobClientStopOptions) (JobClientStopResponse, error)

Stop - Stop the job identified by jobName. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. options - JobClientStopOptions contains the optional parameters for the JobClient.Stop method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/stopJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Stop(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobClientStopOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*JobClient) Suspend 

func (client *JobClient) Suspend(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, options *JobClientSuspendOptions) (JobClientSuspendResponse, error)

Suspend - Suspend the job identified by job name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. options - JobClientSuspendOptions contains the optional parameters for the JobClient.Suspend method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/suspendJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Suspend(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobClientSuspendOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type JobClientCreateOptions added in v0.3.0 

type JobClientCreateOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientCreateOptions contains the optional parameters for the JobClient.Create method.

type JobClientCreateResponse added in v0.3.0 

type JobClientCreateResponse struct {
	Job
}

JobClientCreateResponse contains the response from method JobClient.Create.

type JobClientGetOptions added in v0.3.0 

type JobClientGetOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientGetOptions contains the optional parameters for the JobClient.Get method.

type JobClientGetOutputOptions added in v0.3.0 

type JobClientGetOutputOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientGetOutputOptions contains the optional parameters for the JobClient.GetOutput method.

type JobClientGetOutputResponse added in v0.3.0 

type JobClientGetOutputResponse struct {
	Value *string
}

JobClientGetOutputResponse contains the response from method JobClient.GetOutput.

type JobClientGetResponse added in v0.3.0 

type JobClientGetResponse struct {
	Job
}

JobClientGetResponse contains the response from method JobClient.Get.

type JobClientGetRunbookContentOptions added in v0.3.0 

type JobClientGetRunbookContentOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientGetRunbookContentOptions contains the optional parameters for the JobClient.GetRunbookContent method.

type JobClientGetRunbookContentResponse added in v0.3.0 

type JobClientGetRunbookContentResponse struct {
	Value *string
}

JobClientGetRunbookContentResponse contains the response from method JobClient.GetRunbookContent.

type JobClientListByAutomationAccountOptions added in v0.3.0 

type JobClientListByAutomationAccountOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
	// The filter to apply on the operation.
	Filter *string
}

JobClientListByAutomationAccountOptions contains the optional parameters for the JobClient.ListByAutomationAccount method.

type JobClientListByAutomationAccountResponse added in v0.3.0 

type JobClientListByAutomationAccountResponse struct {
	JobListResultV2
}

JobClientListByAutomationAccountResponse contains the response from method JobClient.ListByAutomationAccount.

type JobClientResumeOptions added in v0.3.0 

type JobClientResumeOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientResumeOptions contains the optional parameters for the JobClient.Resume method.

type JobClientResumeResponse added in v0.3.0 

type JobClientResumeResponse struct {
}

JobClientResumeResponse contains the response from method JobClient.Resume.

type JobClientStopOptions added in v0.3.0 

type JobClientStopOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientStopOptions contains the optional parameters for the JobClient.Stop method.

type JobClientStopResponse added in v0.3.0 

type JobClientStopResponse struct {
}

JobClientStopResponse contains the response from method JobClient.Stop.

type JobClientSuspendOptions added in v0.3.0 

type JobClientSuspendOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobClientSuspendOptions contains the optional parameters for the JobClient.Suspend method.

type JobClientSuspendResponse added in v0.3.0 

type JobClientSuspendResponse struct {
}

JobClientSuspendResponse contains the response from method JobClient.Suspend.

type JobCollectionItem 

type JobCollectionItem struct {
	// REQUIRED; Job properties.
	Properties *JobCollectionItemProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

JobCollectionItem - Job collection item properties.

type JobCollectionItemProperties 

type JobCollectionItemProperties struct {
	// Specifies the runOn group name where the job was executed.
	RunOn *string `json:"runOn,omitempty"`

	// READ-ONLY; The creation time of the job.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; The end time of the job.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; The id of the job.
	JobID *string `json:"jobId,omitempty" azure:"ro"`

	// READ-ONLY; The last modified time of the job.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of a resource.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The runbook association.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty" azure:"ro"`

	// READ-ONLY; The start time of the job.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; The status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`
}

JobCollectionItemProperties - Job collection item properties.

func (JobCollectionItemProperties) MarshalJSON 

func (j JobCollectionItemProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobCollectionItemProperties.

func (*JobCollectionItemProperties) UnmarshalJSON 

func (j *JobCollectionItemProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobCollectionItemProperties.

type JobCreateParameters 

type JobCreateParameters struct {
	// REQUIRED; Gets or sets the list of job properties.
	Properties *JobCreateProperties `json:"properties,omitempty"`
}

JobCreateParameters - The parameters supplied to the create job operation.

type JobCreateProperties 

type JobCreateProperties struct {
	// Gets or sets the parameters of the job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the runOn which specifies the group name where the job is to be executed.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the runbook.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty"`
}

func (JobCreateProperties) MarshalJSON 

func (j JobCreateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobCreateProperties.

type JobListResultV2 

type JobListResultV2 struct {
	// List of jobs.
	Value []*JobCollectionItem `json:"value,omitempty"`

	// READ-ONLY; The link to the next page.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

JobListResultV2 - The response model for the list job operation.

type JobNavigation 

type JobNavigation struct {
	// READ-ONLY; Id of the job associated with the software update configuration run
	ID *string `json:"id,omitempty" azure:"ro"`
}

JobNavigation - Software update configuration machine run job navigation properties.

type JobProperties 

type JobProperties struct {
	// Gets or sets the creation time of the job.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the end time of the job.
	EndTime *time.Time `json:"endTime,omitempty"`

	// Gets or sets the exception of the job.
	Exception *string `json:"exception,omitempty"`

	// Gets or sets the id of the job.
	JobID *string `json:"jobId,omitempty"`

	// Gets or sets the last modified time of the job.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the last status modified time of the job.
	LastStatusModifiedTime *time.Time `json:"lastStatusModifiedTime,omitempty"`

	// Gets or sets the parameters of the job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// The current provisioning state of the job.
	ProvisioningState *JobProvisioningState `json:"provisioningState,omitempty"`

	// Gets or sets the runOn which specifies the group name where the job is to be executed.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the runbook.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty"`

	// Gets or sets the start time of the job.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Gets or sets the job started by.
	StartedBy *string `json:"startedBy,omitempty"`

	// Gets or sets the status of the job.
	Status *JobStatus `json:"status,omitempty"`

	// Gets or sets the status details of the job.
	StatusDetails *string `json:"statusDetails,omitempty"`
}

JobProperties - Definition of job properties.

func (JobProperties) MarshalJSON 

func (j JobProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobProperties.

func (*JobProperties) UnmarshalJSON 

func (j *JobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobProperties.

type JobProvisioningState 

type JobProvisioningState string

JobProvisioningState - The provisioning state of the resource. 

const (
	JobProvisioningStateFailed     JobProvisioningState = "Failed"
	JobProvisioningStateProcessing JobProvisioningState = "Processing"
	JobProvisioningStateSucceeded  JobProvisioningState = "Succeeded"
	JobProvisioningStateSuspended  JobProvisioningState = "Suspended"
)

func PossibleJobProvisioningStateValues 

func PossibleJobProvisioningStateValues() []JobProvisioningState

PossibleJobProvisioningStateValues returns the possible values for the JobProvisioningState const type.

type JobSchedule 

type JobSchedule struct {
	// Gets or sets the properties of the job schedule.
	Properties *JobScheduleProperties `json:"properties,omitempty"`

	// READ-ONLY; Gets the id of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Gets the name of the variable.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

JobSchedule - Definition of the job schedule.

type JobScheduleClient 

type JobScheduleClient struct {
	// contains filtered or unexported fields
}

JobScheduleClient contains the methods for the JobSchedule group. Don't use this type directly, use NewJobScheduleClient() instead.

func NewJobScheduleClient 

func NewJobScheduleClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobScheduleClient, error)

NewJobScheduleClient creates a new instance of JobScheduleClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*JobScheduleClient) Create 

func (client *JobScheduleClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, jobScheduleID string, parameters JobScheduleCreateParameters, options *JobScheduleClientCreateOptions) (JobScheduleClientCreateResponse, error)

Create - Create a job schedule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobScheduleID - The job schedule name. parameters - The parameters supplied to the create job schedule operation. options - JobScheduleClientCreateOptions contains the optional parameters for the JobScheduleClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createJobSchedule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Create(ctx,
		"rg",
		"ContoseAutomationAccount",
		"0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
		armautomation.JobScheduleCreateParameters{
			Properties: &armautomation.JobScheduleCreateProperties{
				Parameters: map[string]*string{
					"jobscheduletag01": to.Ptr("jobschedulevalue01"),
					"jobscheduletag02": to.Ptr("jobschedulevalue02"),
				},
				Runbook: &armautomation.RunbookAssociationProperty{
					Name: to.Ptr("TestRunbook"),
				},
				Schedule: &armautomation.ScheduleAssociationProperty{
					Name: to.Ptr("ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*JobScheduleClient) Delete 

func (client *JobScheduleClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, jobScheduleID string, options *JobScheduleClientDeleteOptions) (JobScheduleClientDeleteResponse, error)

Delete - Delete the job schedule identified by job schedule name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobScheduleID - The job schedule name. options - JobScheduleClientDeleteOptions contains the optional parameters for the JobScheduleClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteJobSchedule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"ContoseAutomationAccount",
		"0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*JobScheduleClient) Get 

func (client *JobScheduleClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, jobScheduleID string, options *JobScheduleClientGetOptions) (JobScheduleClientGetResponse, error)

Get - Retrieve the job schedule identified by job schedule name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobScheduleID - The job schedule name. options - JobScheduleClientGetOptions contains the optional parameters for the JobScheduleClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getJobSchedule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"ContoseAutomationAccount",
		"0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*JobScheduleClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *JobScheduleClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *JobScheduleClientListByAutomationAccountOptions) *runtime.Pager[JobScheduleClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of job schedules. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - JobScheduleClientListByAutomationAccountOptions contains the optional parameters for the JobScheduleClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listAllJobSchedulesByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"ContoseAutomationAccount",
		&armautomation.JobScheduleClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type JobScheduleClientCreateOptions added in v0.3.0 

type JobScheduleClientCreateOptions struct {
}

JobScheduleClientCreateOptions contains the optional parameters for the JobScheduleClient.Create method.

type JobScheduleClientCreateResponse added in v0.3.0 

type JobScheduleClientCreateResponse struct {
	JobSchedule
}

JobScheduleClientCreateResponse contains the response from method JobScheduleClient.Create.

type JobScheduleClientDeleteOptions added in v0.3.0 

type JobScheduleClientDeleteOptions struct {
}

JobScheduleClientDeleteOptions contains the optional parameters for the JobScheduleClient.Delete method.

type JobScheduleClientDeleteResponse added in v0.3.0 

type JobScheduleClientDeleteResponse struct {
}

JobScheduleClientDeleteResponse contains the response from method JobScheduleClient.Delete.

type JobScheduleClientGetOptions added in v0.3.0 

type JobScheduleClientGetOptions struct {
}

JobScheduleClientGetOptions contains the optional parameters for the JobScheduleClient.Get method.

type JobScheduleClientGetResponse added in v0.3.0 

type JobScheduleClientGetResponse struct {
	JobSchedule
}

JobScheduleClientGetResponse contains the response from method JobScheduleClient.Get.

type JobScheduleClientListByAutomationAccountOptions added in v0.3.0 

type JobScheduleClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

JobScheduleClientListByAutomationAccountOptions contains the optional parameters for the JobScheduleClient.ListByAutomationAccount method.

type JobScheduleClientListByAutomationAccountResponse added in v0.3.0 

type JobScheduleClientListByAutomationAccountResponse struct {
	JobScheduleListResult
}

JobScheduleClientListByAutomationAccountResponse contains the response from method JobScheduleClient.ListByAutomationAccount.

type JobScheduleCreateParameters 

type JobScheduleCreateParameters struct {
	// REQUIRED; Gets or sets the list of job schedule properties.
	Properties *JobScheduleCreateProperties `json:"properties,omitempty"`
}

JobScheduleCreateParameters - The parameters supplied to the create job schedule operation.

type JobScheduleCreateProperties 

type JobScheduleCreateProperties struct {
	// REQUIRED; Gets or sets the runbook.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty"`

	// REQUIRED; Gets or sets the schedule.
	Schedule *ScheduleAssociationProperty `json:"schedule,omitempty"`

	// Gets or sets a list of job properties.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the hybrid worker group that the scheduled job should run on.
	RunOn *string `json:"runOn,omitempty"`
}

JobScheduleCreateProperties - The parameters supplied to the create job schedule operation.

func (JobScheduleCreateProperties) MarshalJSON 

func (j JobScheduleCreateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobScheduleCreateProperties.

type JobScheduleListResult 

type JobScheduleListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of job schedules.
	Value []*JobSchedule `json:"value,omitempty"`
}

JobScheduleListResult - The response model for the list job schedule operation.

type JobScheduleProperties 

type JobScheduleProperties struct {
	// Gets or sets the id of job schedule.
	JobScheduleID *string `json:"jobScheduleId,omitempty"`

	// Gets or sets the parameters of the job schedule.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the hybrid worker group that the scheduled job should run on.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the runbook.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty"`

	// Gets or sets the schedule.
	Schedule *ScheduleAssociationProperty `json:"schedule,omitempty"`
}

JobScheduleProperties - Definition of job schedule parameters.

type JobStatus 

type JobStatus string

JobStatus - Gets or sets the status of the job. 

const (
	JobStatusActivating   JobStatus = "Activating"
	JobStatusBlocked      JobStatus = "Blocked"
	JobStatusCompleted    JobStatus = "Completed"
	JobStatusDisconnected JobStatus = "Disconnected"
	JobStatusFailed       JobStatus = "Failed"
	JobStatusNew          JobStatus = "New"
	JobStatusRemoving     JobStatus = "Removing"
	JobStatusResuming     JobStatus = "Resuming"
	JobStatusRunning      JobStatus = "Running"
	JobStatusStopped      JobStatus = "Stopped"
	JobStatusStopping     JobStatus = "Stopping"
	JobStatusSuspended    JobStatus = "Suspended"
	JobStatusSuspending   JobStatus = "Suspending"
)

func PossibleJobStatusValues 

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

type JobStream 

type JobStream struct {
	// Gets or sets the id of the resource.
	ID *string `json:"id,omitempty"`

	// Gets or sets the id of the job stream.
	Properties *JobStreamProperties `json:"properties,omitempty"`
}

JobStream - Definition of the job stream.

type JobStreamClient 

type JobStreamClient struct {
	// contains filtered or unexported fields
}

JobStreamClient contains the methods for the JobStream group. Don't use this type directly, use NewJobStreamClient() instead.

func NewJobStreamClient 

func NewJobStreamClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobStreamClient, error)

NewJobStreamClient creates a new instance of JobStreamClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*JobStreamClient) Get 

func (client *JobStreamClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, jobName string, jobStreamID string, options *JobStreamClientGetOptions) (JobStreamClientGetResponse, error)

Get - Retrieve the job stream identified by job stream id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. jobStreamID - The job stream id. options - JobStreamClientGetOptions contains the optional parameters for the JobStreamClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/getJobStream.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobStreamClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"foo",
		"851b2101-686f-40e2-8a4b-5b8df08afbd1_00636535684910693884_00000000000000000001",
		&armautomation.JobStreamClientGetOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*JobStreamClient) NewListByJobPager added in v0.5.0 

func (client *JobStreamClient) NewListByJobPager(resourceGroupName string, automationAccountName string, jobName string, options *JobStreamClientListByJobOptions) *runtime.Pager[JobStreamClientListByJobResponse]

NewListByJobPager - Retrieve a list of jobs streams identified by job name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. jobName - The job name. options - JobStreamClientListByJobOptions contains the optional parameters for the JobStreamClient.ListByJob method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/listJobStreamsByJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewJobStreamClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByJobPager("mygroup",
		"ContoseAutomationAccount",
		"foo",
		&armautomation.JobStreamClientListByJobOptions{Filter: nil,
			ClientRequestID: nil,
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type JobStreamClientGetOptions added in v0.3.0 

type JobStreamClientGetOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

JobStreamClientGetOptions contains the optional parameters for the JobStreamClient.Get method.

type JobStreamClientGetResponse added in v0.3.0 

type JobStreamClientGetResponse struct {
	JobStream
}

JobStreamClientGetResponse contains the response from method JobStreamClient.Get.

type JobStreamClientListByJobOptions added in v0.3.0 

type JobStreamClientListByJobOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
	// The filter to apply on the operation.
	Filter *string
}

JobStreamClientListByJobOptions contains the optional parameters for the JobStreamClient.ListByJob method.

type JobStreamClientListByJobResponse added in v0.3.0 

type JobStreamClientListByJobResponse struct {
	JobStreamListResult
}

JobStreamClientListByJobResponse contains the response from method JobStreamClient.ListByJob.

type JobStreamListResult 

type JobStreamListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of job streams.
	Value []*JobStream `json:"value,omitempty"`
}

JobStreamListResult - The response model for the list job stream operation.

type JobStreamProperties 

type JobStreamProperties struct {
	// Gets or sets the id of the job stream.
	JobStreamID *string `json:"jobStreamId,omitempty"`

	// Gets or sets the stream text.
	StreamText *string `json:"streamText,omitempty"`

	// Gets or sets the stream type.
	StreamType *JobStreamType `json:"streamType,omitempty"`

	// Gets or sets the summary.
	Summary *string `json:"summary,omitempty"`

	// Gets or sets the creation time of the job.
	Time *time.Time `json:"time,omitempty"`

	// Gets or sets the values of the job stream.
	Value map[string]interface{} `json:"value,omitempty"`
}

JobStreamProperties - Definition of the job stream.

func (*JobStreamProperties) UnmarshalJSON 

func (j *JobStreamProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobStreamProperties.

type JobStreamType 

type JobStreamType string

JobStreamType - Gets or sets the stream type. 

const (
	JobStreamTypeAny      JobStreamType = "Any"
	JobStreamTypeDebug    JobStreamType = "Debug"
	JobStreamTypeError    JobStreamType = "Error"
	JobStreamTypeOutput   JobStreamType = "Output"
	JobStreamTypeProgress JobStreamType = "Progress"
	JobStreamTypeVerbose  JobStreamType = "Verbose"
	JobStreamTypeWarning  JobStreamType = "Warning"
)

func PossibleJobStreamTypeValues 

func PossibleJobStreamTypeValues() []JobStreamType

PossibleJobStreamTypeValues returns the possible values for the JobStreamType const type.

type Key 

type Key struct {
	// READ-ONLY; Automation key name.
	KeyName *AutomationKeyName `json:"KeyName,omitempty" azure:"ro"`

	// READ-ONLY; Automation key permissions.
	Permissions *AutomationKeyPermissions `json:"Permissions,omitempty" azure:"ro"`

	// READ-ONLY; Value of the Automation Key used for registration.
	Value *string `json:"Value,omitempty" azure:"ro"`
}

Key - Automation key which is used to register a DSC Node

type KeyListResult 

type KeyListResult struct {
	// Lists the automation keys.
	Keys []*Key `json:"keys,omitempty"`
}

type KeyVaultProperties 

type KeyVaultProperties struct {
	// The name of key used to encrypt data.
	KeyName *string `json:"keyName,omitempty"`

	// The key version of the key used to encrypt data.
	KeyVersion *string `json:"keyVersion,omitempty"`

	// The URI of the key vault key used to encrypt data.
	KeyvaultURI *string `json:"keyvaultUri,omitempty"`
}

KeyVaultProperties - Settings concerning key vault encryption for a configuration store.

type KeysClient 

type KeysClient struct {
	// contains filtered or unexported fields
}

KeysClient contains the methods for the Keys group. Don't use this type directly, use NewKeysClient() instead.

func NewKeysClient 

func NewKeysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KeysClient, error)

NewKeysClient creates a new instance of KeysClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*KeysClient) ListByAutomationAccount 

func (client *KeysClient) ListByAutomationAccount(ctx context.Context, resourceGroupName string, automationAccountName string, options *KeysClientListByAutomationAccountOptions) (KeysClientListByAutomationAccountResponse, error)

ListByAutomationAccount - Retrieve the automation keys for an account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - KeysClientListByAutomationAccountOptions contains the optional parameters for the KeysClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/listAutomationAccountKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewKeysClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByAutomationAccount(ctx,
		"rg",
		"MyAutomationAccount",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type KeysClientListByAutomationAccountOptions added in v0.3.0 

type KeysClientListByAutomationAccountOptions struct {
}

KeysClientListByAutomationAccountOptions contains the optional parameters for the KeysClient.ListByAutomationAccount method.

type KeysClientListByAutomationAccountResponse added in v0.3.0 

type KeysClientListByAutomationAccountResponse struct {
	KeyListResult
}

KeysClientListByAutomationAccountResponse contains the response from method KeysClient.ListByAutomationAccount.

type LinkedWorkspace 

type LinkedWorkspace struct {
	// READ-ONLY; Gets the id of the linked workspace.
	ID *string `json:"id,omitempty" azure:"ro"`
}

LinkedWorkspace - Definition of the linked workspace.

type LinkedWorkspaceClient 

type LinkedWorkspaceClient struct {
	// contains filtered or unexported fields
}

LinkedWorkspaceClient contains the methods for the LinkedWorkspace group. Don't use this type directly, use NewLinkedWorkspaceClient() instead.

func NewLinkedWorkspaceClient 

func NewLinkedWorkspaceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LinkedWorkspaceClient, error)

NewLinkedWorkspaceClient creates a new instance of LinkedWorkspaceClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LinkedWorkspaceClient) Get 

func (client *LinkedWorkspaceClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, options *LinkedWorkspaceClientGetOptions) (LinkedWorkspaceClientGetResponse, error)

Get - Retrieve the linked workspace for the account id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - LinkedWorkspaceClientGetOptions contains the optional parameters for the LinkedWorkspaceClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getLinkedWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewLinkedWorkspaceClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"ContosoAutomationAccount",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type LinkedWorkspaceClientGetOptions added in v0.3.0 

type LinkedWorkspaceClientGetOptions struct {
}

LinkedWorkspaceClientGetOptions contains the optional parameters for the LinkedWorkspaceClient.Get method.

type LinkedWorkspaceClientGetResponse added in v0.3.0 

type LinkedWorkspaceClientGetResponse struct {
	LinkedWorkspace
}

LinkedWorkspaceClientGetResponse contains the response from method LinkedWorkspaceClient.Get.

type LinuxProperties 

type LinuxProperties struct {
	// packages excluded from the software update configuration.
	ExcludedPackageNameMasks []*string `json:"excludedPackageNameMasks,omitempty"`

	// Update classifications included in the software update configuration.
	IncludedPackageClassifications *LinuxUpdateClasses `json:"includedPackageClassifications,omitempty"`

	// packages included from the software update configuration.
	IncludedPackageNameMasks []*string `json:"includedPackageNameMasks,omitempty"`

	// Reboot setting for the software update configuration.
	RebootSetting *string `json:"rebootSetting,omitempty"`
}

LinuxProperties - Linux specific update configuration.

func (LinuxProperties) MarshalJSON 

func (l LinuxProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinuxProperties.

type LinuxUpdateClasses 

type LinuxUpdateClasses string

LinuxUpdateClasses - Update classifications included in the software update configuration. 

const (
	LinuxUpdateClassesCritical     LinuxUpdateClasses = "Critical"
	LinuxUpdateClassesOther        LinuxUpdateClasses = "Other"
	LinuxUpdateClassesSecurity     LinuxUpdateClasses = "Security"
	LinuxUpdateClassesUnclassified LinuxUpdateClasses = "Unclassified"
)

func PossibleLinuxUpdateClassesValues 

func PossibleLinuxUpdateClassesValues() []LinuxUpdateClasses

PossibleLinuxUpdateClassesValues returns the possible values for the LinuxUpdateClasses const type.

type Module 

type Module struct {
	// Gets or sets the etag of the resource.
	Etag *string `json:"etag,omitempty"`

	// The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`

	// Gets or sets the module properties.
	Properties *ModuleProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Module - Definition of the module type.

func (Module) MarshalJSON 

func (m Module) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Module.

type ModuleClient 

type ModuleClient struct {
	// contains filtered or unexported fields
}

ModuleClient contains the methods for the Module group. Don't use this type directly, use NewModuleClient() instead.

func NewModuleClient 

func NewModuleClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ModuleClient, error)

NewModuleClient creates a new instance of ModuleClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ModuleClient) CreateOrUpdate 

func (client *ModuleClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, parameters ModuleCreateOrUpdateParameters, options *ModuleClientCreateOrUpdateOptions) (ModuleClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update the module identified by module name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The name of module. parameters - The create or update parameters for module. options - ModuleClientCreateOrUpdateOptions contains the optional parameters for the ModuleClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateModule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewModuleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		armautomation.ModuleCreateOrUpdateParameters{
			Properties: &armautomation.ModuleCreateOrUpdateProperties{
				ContentLink: &armautomation.ContentLink{
					ContentHash: &armautomation.ContentHash{
						Algorithm: to.Ptr("sha265"),
						Value:     to.Ptr("07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"),
					},
					URI:     to.Ptr("https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip"),
					Version: to.Ptr("1.0.0.0"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ModuleClient) Delete 

func (client *ModuleClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, options *ModuleClientDeleteOptions) (ModuleClientDeleteResponse, error)

Delete - Delete the module by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The module name. options - ModuleClientDeleteOptions contains the optional parameters for the ModuleClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteModule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewModuleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ModuleClient) Get 

func (client *ModuleClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, options *ModuleClientGetOptions) (ModuleClientGetResponse, error)

Get - Retrieve the module identified by module name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The module name. options - ModuleClientGetOptions contains the optional parameters for the ModuleClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getModule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewModuleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ModuleClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *ModuleClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *ModuleClientListByAutomationAccountOptions) *runtime.Pager[ModuleClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of modules. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - ModuleClientListByAutomationAccountOptions contains the optional parameters for the ModuleClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listModulesByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewModuleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ModuleClient) Update 

func (client *ModuleClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, parameters ModuleUpdateParameters, options *ModuleClientUpdateOptions) (ModuleClientUpdateResponse, error)

Update - Update the module identified by module name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The name of module. parameters - The update parameters for module. options - ModuleClientUpdateOptions contains the optional parameters for the ModuleClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateModule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewModuleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"MyAutomationAccount",
		"MyModule",
		armautomation.ModuleUpdateParameters{
			Properties: &armautomation.ModuleUpdateProperties{
				ContentLink: &armautomation.ContentLink{
					ContentHash: &armautomation.ContentHash{
						Algorithm: to.Ptr("sha265"),
						Value:     to.Ptr("07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"),
					},
					URI:     to.Ptr("https://teststorage.blob.core.windows.net/mycontainer/MyModule.zip"),
					Version: to.Ptr("1.0.0.0"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type ModuleClientCreateOrUpdateOptions added in v0.3.0 

type ModuleClientCreateOrUpdateOptions struct {
}

ModuleClientCreateOrUpdateOptions contains the optional parameters for the ModuleClient.CreateOrUpdate method.

type ModuleClientCreateOrUpdateResponse added in v0.3.0 

type ModuleClientCreateOrUpdateResponse struct {
	Module
}

ModuleClientCreateOrUpdateResponse contains the response from method ModuleClient.CreateOrUpdate.

type ModuleClientDeleteOptions added in v0.3.0 

type ModuleClientDeleteOptions struct {
}

ModuleClientDeleteOptions contains the optional parameters for the ModuleClient.Delete method.

type ModuleClientDeleteResponse added in v0.3.0 

type ModuleClientDeleteResponse struct {
}

ModuleClientDeleteResponse contains the response from method ModuleClient.Delete.

type ModuleClientGetOptions added in v0.3.0 

type ModuleClientGetOptions struct {
}

ModuleClientGetOptions contains the optional parameters for the ModuleClient.Get method.

type ModuleClientGetResponse added in v0.3.0 

type ModuleClientGetResponse struct {
	Module
}

ModuleClientGetResponse contains the response from method ModuleClient.Get.

type ModuleClientListByAutomationAccountOptions added in v0.3.0 

type ModuleClientListByAutomationAccountOptions struct {
}

ModuleClientListByAutomationAccountOptions contains the optional parameters for the ModuleClient.ListByAutomationAccount method.

type ModuleClientListByAutomationAccountResponse added in v0.3.0 

type ModuleClientListByAutomationAccountResponse struct {
	ModuleListResult
}

ModuleClientListByAutomationAccountResponse contains the response from method ModuleClient.ListByAutomationAccount.

type ModuleClientUpdateOptions added in v0.3.0 

type ModuleClientUpdateOptions struct {
}

ModuleClientUpdateOptions contains the optional parameters for the ModuleClient.Update method.

type ModuleClientUpdateResponse added in v0.3.0 

type ModuleClientUpdateResponse struct {
	Module
}

ModuleClientUpdateResponse contains the response from method ModuleClient.Update.

type ModuleCreateOrUpdateParameters 

type ModuleCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the module create properties.
	Properties *ModuleCreateOrUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

ModuleCreateOrUpdateParameters - The parameters supplied to the create or update module operation.

func (ModuleCreateOrUpdateParameters) MarshalJSON 

func (m ModuleCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModuleCreateOrUpdateParameters.

type ModuleCreateOrUpdateProperties 

type ModuleCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the module content link.
	ContentLink *ContentLink `json:"contentLink,omitempty"`
}

ModuleCreateOrUpdateProperties - The parameters supplied to the create or update module properties.

type ModuleErrorInfo 

type ModuleErrorInfo struct {
	// Gets or sets the error code.
	Code *string `json:"code,omitempty"`

	// Gets or sets the error message.
	Message *string `json:"message,omitempty"`
}

ModuleErrorInfo - Definition of the module error info type.

type ModuleListResult 

type ModuleListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of modules.
	Value []*Module `json:"value,omitempty"`
}

ModuleListResult - The response model for the list module operation.

type ModuleProperties 

type ModuleProperties struct {
	// Gets or sets the activity count of the module.
	ActivityCount *int32 `json:"activityCount,omitempty"`

	// Gets or sets the contentLink of the module.
	ContentLink *ContentLink `json:"contentLink,omitempty"`

	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the error info of the module.
	Error *ModuleErrorInfo `json:"error,omitempty"`

	// Gets or sets type of module, if its composite or not.
	IsComposite *bool `json:"isComposite,omitempty"`

	// Gets or sets the isGlobal flag of the module.
	IsGlobal *bool `json:"isGlobal,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the provisioning state of the module.
	ProvisioningState *ModuleProvisioningState `json:"provisioningState,omitempty"`

	// Gets or sets the size in bytes of the module.
	SizeInBytes *int64 `json:"sizeInBytes,omitempty"`

	// Gets or sets the version of the module.
	Version *string `json:"version,omitempty"`
}

ModuleProperties - Definition of the module property type.

func (ModuleProperties) MarshalJSON 

func (m ModuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModuleProperties.

func (*ModuleProperties) UnmarshalJSON 

func (m *ModuleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModuleProperties.

type ModuleProvisioningState 

type ModuleProvisioningState string

ModuleProvisioningState - Gets or sets the provisioning state of the module. 

const (
	ModuleProvisioningStateCreated                     ModuleProvisioningState = "Created"
	ModuleProvisioningStateCreating                    ModuleProvisioningState = "Creating"
	ModuleProvisioningStateStartingImportModuleRunbook ModuleProvisioningState = "StartingImportModuleRunbook"
	ModuleProvisioningStateRunningImportModuleRunbook  ModuleProvisioningState = "RunningImportModuleRunbook"
	ModuleProvisioningStateContentRetrieved            ModuleProvisioningState = "ContentRetrieved"
	ModuleProvisioningStateContentDownloaded           ModuleProvisioningState = "ContentDownloaded"
	ModuleProvisioningStateContentValidated            ModuleProvisioningState = "ContentValidated"
	ModuleProvisioningStateConnectionTypeImported      ModuleProvisioningState = "ConnectionTypeImported"
	ModuleProvisioningStateContentStored               ModuleProvisioningState = "ContentStored"
	ModuleProvisioningStateModuleDataStored            ModuleProvisioningState = "ModuleDataStored"
	ModuleProvisioningStateActivitiesStored            ModuleProvisioningState = "ActivitiesStored"
	ModuleProvisioningStateModuleImportRunbookComplete ModuleProvisioningState = "ModuleImportRunbookComplete"
	ModuleProvisioningStateSucceeded                   ModuleProvisioningState = "Succeeded"
	ModuleProvisioningStateFailed                      ModuleProvisioningState = "Failed"
	ModuleProvisioningStateCancelled                   ModuleProvisioningState = "Cancelled"
	ModuleProvisioningStateUpdating                    ModuleProvisioningState = "Updating"
)

func PossibleModuleProvisioningStateValues 

func PossibleModuleProvisioningStateValues() []ModuleProvisioningState

PossibleModuleProvisioningStateValues returns the possible values for the ModuleProvisioningState const type.

type ModuleUpdateParameters 

type ModuleUpdateParameters struct {
	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the module update properties.
	Properties *ModuleUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

ModuleUpdateParameters - The parameters supplied to the update module operation.

func (ModuleUpdateParameters) MarshalJSON 

func (m ModuleUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModuleUpdateParameters.

type ModuleUpdateProperties 

type ModuleUpdateProperties struct {
	// Gets or sets the module content link.
	ContentLink *ContentLink `json:"contentLink,omitempty"`
}

ModuleUpdateProperties - The parameters supplied to the update properties.

type NodeCount 

type NodeCount struct {
	// Gets the name of a count type
	Name       *string              `json:"name,omitempty"`
	Properties *NodeCountProperties `json:"properties,omitempty"`
}

NodeCount - Number of nodes based on the Filter

type NodeCountInformationClient 

type NodeCountInformationClient struct {
	// contains filtered or unexported fields
}

NodeCountInformationClient contains the methods for the NodeCountInformation group. Don't use this type directly, use NewNodeCountInformationClient() instead.

func NewNodeCountInformationClient 

func NewNodeCountInformationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NodeCountInformationClient, error)

NewNodeCountInformationClient creates a new instance of NodeCountInformationClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*NodeCountInformationClient) Get 

func (client *NodeCountInformationClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, countType CountType, options *NodeCountInformationClientGetOptions) (NodeCountInformationClientGetResponse, error)

Get - Retrieve counts for Dsc Nodes. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. countType - The type of counts to retrieve options - NodeCountInformationClientGetOptions contains the optional parameters for the NodeCountInformationClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listPagedDscNodeConfigurationCounts.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewNodeCountInformationClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		armautomation.CountTypeNodeconfiguration,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type NodeCountInformationClientGetOptions added in v0.3.0 

type NodeCountInformationClientGetOptions struct {
}

NodeCountInformationClientGetOptions contains the optional parameters for the NodeCountInformationClient.Get method.

type NodeCountInformationClientGetResponse added in v0.3.0 

type NodeCountInformationClientGetResponse struct {
	NodeCounts
}

NodeCountInformationClientGetResponse contains the response from method NodeCountInformationClient.Get.

type NodeCountProperties 

type NodeCountProperties struct {
	// Gets the count for the name
	Count *int32 `json:"count,omitempty"`
}

type NodeCounts 

type NodeCounts struct {
	// Gets the total number of records matching countType criteria.
	TotalCount *int32 `json:"totalCount,omitempty"`

	// Gets an array of counts
	Value []*NodeCount `json:"value,omitempty"`
}

NodeCounts - Gets the count of nodes by count type

type NodeReportsClient 

type NodeReportsClient struct {
	// contains filtered or unexported fields
}

NodeReportsClient contains the methods for the NodeReports group. Don't use this type directly, use NewNodeReportsClient() instead.

func NewNodeReportsClient 

func NewNodeReportsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NodeReportsClient, error)

NewNodeReportsClient creates a new instance of NodeReportsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*NodeReportsClient) Get 

func (client *NodeReportsClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, nodeID string, reportID string, options *NodeReportsClientGetOptions) (NodeReportsClientGetResponse, error)

Get - Retrieve the Dsc node report data by node id and report id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeID - The Dsc node id. reportID - The report id. options - NodeReportsClientGetOptions contains the optional parameters for the NodeReportsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getDscNodeReport.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewNodeReportsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"nodeId",
		"903a5ead-140c-11e7-a943-000d3a6140c9",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*NodeReportsClient) GetContent 

func (client *NodeReportsClient) GetContent(ctx context.Context, resourceGroupName string, automationAccountName string, nodeID string, reportID string, options *NodeReportsClientGetContentOptions) (NodeReportsClientGetContentResponse, error)

GetContent - Retrieve the Dsc node reports by node id and report id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeID - The Dsc node id. reportID - The report id. options - NodeReportsClientGetContentOptions contains the optional parameters for the NodeReportsClient.GetContent method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getDscNodeReportContent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewNodeReportsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetContent(ctx,
		"rg",
		"myAutomationAccount33",
		"nodeId",
		"reportId",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*NodeReportsClient) NewListByNodePager added in v0.5.0 

func (client *NodeReportsClient) NewListByNodePager(resourceGroupName string, automationAccountName string, nodeID string, options *NodeReportsClientListByNodeOptions) *runtime.Pager[NodeReportsClientListByNodeResponse]

NewListByNodePager - Retrieve the Dsc node report list by node id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. nodeID - The parameters supplied to the list operation. options - NodeReportsClientListByNodeOptions contains the optional parameters for the NodeReportsClient.ListByNode method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listDscNodeReportsByNode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewNodeReportsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByNodePager("rg",
		"myAutomationAccount33",
		"nodeId",
		&armautomation.NodeReportsClientListByNodeOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type NodeReportsClientGetContentOptions added in v0.3.0 

type NodeReportsClientGetContentOptions struct {
}

NodeReportsClientGetContentOptions contains the optional parameters for the NodeReportsClient.GetContent method.

type NodeReportsClientGetContentResponse added in v0.3.0 

type NodeReportsClientGetContentResponse struct {
	// Anything
	Interface interface{}
}

NodeReportsClientGetContentResponse contains the response from method NodeReportsClient.GetContent.

type NodeReportsClientGetOptions added in v0.3.0 

type NodeReportsClientGetOptions struct {
}

NodeReportsClientGetOptions contains the optional parameters for the NodeReportsClient.Get method.

type NodeReportsClientGetResponse added in v0.3.0 

type NodeReportsClientGetResponse struct {
	DscNodeReport
}

NodeReportsClientGetResponse contains the response from method NodeReportsClient.Get.

type NodeReportsClientListByNodeOptions added in v0.3.0 

type NodeReportsClientListByNodeOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

NodeReportsClientListByNodeOptions contains the optional parameters for the NodeReportsClient.ListByNode method.

type NodeReportsClientListByNodeResponse added in v0.3.0 

type NodeReportsClientListByNodeResponse struct {
	DscNodeReportListResult
}

NodeReportsClientListByNodeResponse contains the response from method NodeReportsClient.ListByNode.

type NonAzureQueryProperties 

type NonAzureQueryProperties struct {
	// Log Analytics Saved Search name.
	FunctionAlias *string `json:"functionAlias,omitempty"`

	// Workspace Id for Log Analytics in which the saved Search is resided.
	WorkspaceID *string `json:"workspaceId,omitempty"`
}

NonAzureQueryProperties - Non Azure query for the update configuration.

type ObjectDataTypesClient 

type ObjectDataTypesClient struct {
	// contains filtered or unexported fields
}

ObjectDataTypesClient contains the methods for the ObjectDataTypes group. Don't use this type directly, use NewObjectDataTypesClient() instead.

func NewObjectDataTypesClient 

func NewObjectDataTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ObjectDataTypesClient, error)

NewObjectDataTypesClient creates a new instance of ObjectDataTypesClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ObjectDataTypesClient) NewListFieldsByModuleAndTypePager added in v0.5.0 

func (client *ObjectDataTypesClient) NewListFieldsByModuleAndTypePager(resourceGroupName string, automationAccountName string, moduleName string, typeName string, options *ObjectDataTypesClientListFieldsByModuleAndTypeOptions) *runtime.Pager[ObjectDataTypesClientListFieldsByModuleAndTypeResponse]

NewListFieldsByModuleAndTypePager - Retrieve a list of fields of a given type identified by module name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. moduleName - The name of module. typeName - The name of type. options - ObjectDataTypesClientListFieldsByModuleAndTypeOptions contains the optional parameters for the ObjectDataTypesClient.ListFieldsByModuleAndType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listFieldsByModuleAndType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewObjectDataTypesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListFieldsByModuleAndTypePager("rg",
		"MyAutomationAccount",
		"MyModule",
		"MyCustomType",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ObjectDataTypesClient) NewListFieldsByTypePager added in v0.5.0 

func (client *ObjectDataTypesClient) NewListFieldsByTypePager(resourceGroupName string, automationAccountName string, typeName string, options *ObjectDataTypesClientListFieldsByTypeOptions) *runtime.Pager[ObjectDataTypesClientListFieldsByTypeResponse]

NewListFieldsByTypePager - Retrieve a list of fields of a given type across all accessible modules. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. typeName - The name of type. options - ObjectDataTypesClientListFieldsByTypeOptions contains the optional parameters for the ObjectDataTypesClient.ListFieldsByType method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listFieldsByType.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewObjectDataTypesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListFieldsByTypePager("rg",
		"MyAutomationAccount",
		"MyCustomType",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ObjectDataTypesClientListFieldsByModuleAndTypeOptions added in v0.3.0 

type ObjectDataTypesClientListFieldsByModuleAndTypeOptions struct {
}

ObjectDataTypesClientListFieldsByModuleAndTypeOptions contains the optional parameters for the ObjectDataTypesClient.ListFieldsByModuleAndType method.

type ObjectDataTypesClientListFieldsByModuleAndTypeResponse added in v0.3.0 

type ObjectDataTypesClientListFieldsByModuleAndTypeResponse struct {
	TypeFieldListResult
}

ObjectDataTypesClientListFieldsByModuleAndTypeResponse contains the response from method ObjectDataTypesClient.ListFieldsByModuleAndType.

type ObjectDataTypesClientListFieldsByTypeOptions added in v0.3.0 

type ObjectDataTypesClientListFieldsByTypeOptions struct {
}

ObjectDataTypesClientListFieldsByTypeOptions contains the optional parameters for the ObjectDataTypesClient.ListFieldsByType method.

type ObjectDataTypesClientListFieldsByTypeResponse added in v0.3.0 

type ObjectDataTypesClientListFieldsByTypeResponse struct {
	TypeFieldListResult
}

ObjectDataTypesClientListFieldsByTypeResponse contains the response from method ObjectDataTypesClient.ListFieldsByType.

type OperatingSystemType 

type OperatingSystemType string

OperatingSystemType - Target operating system for the software update configuration. 

const (
	OperatingSystemTypeWindows OperatingSystemType = "Windows"
	OperatingSystemTypeLinux   OperatingSystemType = "Linux"
)

func PossibleOperatingSystemTypeValues 

func PossibleOperatingSystemTypeValues() []OperatingSystemType

PossibleOperatingSystemTypeValues returns the possible values for the OperatingSystemType const type.

type Operation 

type Operation struct {
	// Provider, Resource and Operation values
	Display *OperationDisplay `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
}

Operation - Automation REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft.Automation
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed: Runbooks, Jobs etc.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Provider, Resource and Operation values

type OperationListResult 

type OperationListResult struct {
	// List of Automation operations supported by the Automation resource provider.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - The response model for the list of Automation operations

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.5.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available Automation REST API operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - A private endpoint connection

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - A list of private endpoint connections

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// Gets the groupIds.
	GroupIDs []*string `json:"groupIds,omitempty"`

	// Private endpoint which the connection belongs to.
	PrivateEndpoint *PrivateEndpointProperty `json:"privateEndpoint,omitempty"`

	// Connection State of the Private Endpoint Connection.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState,omitempty"`
}

PrivateEndpointConnectionProperties - Properties of a private endpoint connection.

func (PrivateEndpointConnectionProperties) MarshalJSON added in v0.6.0 

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PrivateEndpointConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Approve or reject a private endpoint connection with a given name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. privateEndpointConnectionName - The name of the private endpoint connection. options - PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/PrivateEndpointConnectionUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"ddb1",
		"privateEndpointConnectionName",
		armautomation.PrivateEndpointConnection{
			Properties: &armautomation.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armautomation.PrivateLinkServiceConnectionStateProperty{
					Description: to.Ptr("Approved by johndoe@contoso.com"),
					Status:      to.Ptr("Approved"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, automationAccountName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Deletes a private endpoint connection with a given name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. privateEndpointConnectionName - The name of the private endpoint connection. options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/PrivateEndpointConnectionDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"ddb1",
		"privateEndpointConnectionName",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets a private endpoint connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. privateEndpointConnectionName - The name of the private endpoint connection. options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/PrivateEndpointConnectionGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"ddb1",
		"privateEndpointConnectionName",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*PrivateEndpointConnectionsClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *PrivateEndpointConnectionsClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *PrivateEndpointConnectionsClientListByAutomationAccountOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - List all private endpoint connections on a Automation account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - PrivateEndpointConnectionsClientListByAutomationAccountOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/PrivateEndpointConnectionListGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg1",
		"ddb1",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.3.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.3.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.3.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.3.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByAutomationAccountOptions added in v0.3.0 

type PrivateEndpointConnectionsClientListByAutomationAccountOptions struct {
}

PrivateEndpointConnectionsClientListByAutomationAccountOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByAutomationAccount method.

type PrivateEndpointConnectionsClientListByAutomationAccountResponse added in v0.3.0 

type PrivateEndpointConnectionsClientListByAutomationAccountResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByAutomationAccountResponse contains the response from method PrivateEndpointConnectionsClient.ListByAutomationAccount.

type PrivateEndpointProperty 

type PrivateEndpointProperty struct {
	// Resource id of the private endpoint.
	ID *string `json:"id,omitempty"`
}

PrivateEndpointProperty - Private endpoint which the connection belongs to.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) NewAutomationPager added in v0.5.0 

func (client *PrivateLinkResourcesClient) NewAutomationPager(resourceGroupName string, automationAccountName string, options *PrivateLinkResourcesClientAutomationOptions) *runtime.Pager[PrivateLinkResourcesClientAutomationResponse]

NewAutomationPager - Gets the private link resources that need to be created for Automation account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - PrivateLinkResourcesClientAutomationOptions contains the optional parameters for the PrivateLinkResourcesClient.Automation method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/PrivateLinkResourceListGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPrivateLinkResourcesClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewAutomationPager("rg1",
		"ddb1",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type PrivateLinkResourcesClientAutomationOptions added in v0.3.0 

type PrivateLinkResourcesClientAutomationOptions struct {
}

PrivateLinkResourcesClientAutomationOptions contains the optional parameters for the PrivateLinkResourcesClient.Automation method.

type PrivateLinkResourcesClientAutomationResponse added in v0.3.0 

type PrivateLinkResourcesClientAutomationResponse struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientAutomationResponse contains the response from method PrivateLinkResourcesClient.Automation.

type PrivateLinkServiceConnectionStateProperty 

type PrivateLinkServiceConnectionStateProperty struct {
	// The private link service connection description.
	Description *string `json:"description,omitempty"`

	// The private link service connection status.
	Status *string `json:"status,omitempty"`

	// READ-ONLY; Any action that is required beyond basic workflow (approve/ reject/ disconnect)
	ActionsRequired *string `json:"actionsRequired,omitempty" azure:"ro"`
}

PrivateLinkServiceConnectionStateProperty - Connection State of the Private Endpoint Connection.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The provisioning state of the job. 

const (
	ProvisioningStateCompleted ProvisioningState = "Completed"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateRunning   ProvisioningState = "Running"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - ARM proxy resource.

type Python2PackageClient 

type Python2PackageClient struct {
	// contains filtered or unexported fields
}

Python2PackageClient contains the methods for the Python2Package group. Don't use this type directly, use NewPython2PackageClient() instead.

func NewPython2PackageClient 

func NewPython2PackageClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*Python2PackageClient, error)

NewPython2PackageClient creates a new instance of Python2PackageClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*Python2PackageClient) CreateOrUpdate 

func (client *Python2PackageClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, packageName string, parameters PythonPackageCreateParameters, options *Python2PackageClientCreateOrUpdateOptions) (Python2PackageClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update the python 2 package identified by package name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. packageName - The name of python package. parameters - The create or update parameters for python package. options - Python2PackageClientCreateOrUpdateOptions contains the optional parameters for the Python2PackageClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdatePython2Package.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPython2PackageClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		armautomation.PythonPackageCreateParameters{
			Properties: &armautomation.PythonPackageCreateProperties{
				ContentLink: &armautomation.ContentLink{
					ContentHash: &armautomation.ContentHash{
						Algorithm: to.Ptr("sha265"),
						Value:     to.Ptr("07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"),
					},
					URI:     to.Ptr("https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip"),
					Version: to.Ptr("1.0.0.0"),
				},
			},
			Tags: map[string]*string{},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*Python2PackageClient) Delete 

func (client *Python2PackageClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, packageName string, options *Python2PackageClientDeleteOptions) (Python2PackageClientDeleteResponse, error)

Delete - Delete the python 2 package by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. packageName - The python package name. options - Python2PackageClientDeleteOptions contains the optional parameters for the Python2PackageClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deletePython2Package.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPython2PackageClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*Python2PackageClient) Get 

func (client *Python2PackageClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, packageName string, options *Python2PackageClientGetOptions) (Python2PackageClientGetResponse, error)

Get - Retrieve the python 2 package identified by package name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. packageName - The python package name. options - Python2PackageClientGetOptions contains the optional parameters for the Python2PackageClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getPython2Package.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPython2PackageClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"OmsCompositeResources",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*Python2PackageClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *Python2PackageClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *Python2PackageClientListByAutomationAccountOptions) *runtime.Pager[Python2PackageClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of python 2 packages. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - Python2PackageClientListByAutomationAccountOptions contains the optional parameters for the Python2PackageClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listPython2PackagesByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPython2PackageClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*Python2PackageClient) Update 

func (client *Python2PackageClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, packageName string, parameters PythonPackageUpdateParameters, options *Python2PackageClientUpdateOptions) (Python2PackageClientUpdateResponse, error)

Update - Update the python 2 package identified by package name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. packageName - The name of python package. parameters - The update parameters for python package. options - Python2PackageClientUpdateOptions contains the optional parameters for the Python2PackageClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updatePython2Package.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewPython2PackageClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"MyAutomationAccount",
		"MyPython2Package",
		armautomation.PythonPackageUpdateParameters{
			Tags: map[string]*string{},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type Python2PackageClientCreateOrUpdateOptions added in v0.3.0 

type Python2PackageClientCreateOrUpdateOptions struct {
}

Python2PackageClientCreateOrUpdateOptions contains the optional parameters for the Python2PackageClient.CreateOrUpdate method.

type Python2PackageClientCreateOrUpdateResponse added in v0.3.0 

type Python2PackageClientCreateOrUpdateResponse struct {
	Module
}

Python2PackageClientCreateOrUpdateResponse contains the response from method Python2PackageClient.CreateOrUpdate.

type Python2PackageClientDeleteOptions added in v0.3.0 

type Python2PackageClientDeleteOptions struct {
}

Python2PackageClientDeleteOptions contains the optional parameters for the Python2PackageClient.Delete method.

type Python2PackageClientDeleteResponse added in v0.3.0 

type Python2PackageClientDeleteResponse struct {
}

Python2PackageClientDeleteResponse contains the response from method Python2PackageClient.Delete.

type Python2PackageClientGetOptions added in v0.3.0 

type Python2PackageClientGetOptions struct {
}

Python2PackageClientGetOptions contains the optional parameters for the Python2PackageClient.Get method.

type Python2PackageClientGetResponse added in v0.3.0 

type Python2PackageClientGetResponse struct {
	Module
}

Python2PackageClientGetResponse contains the response from method Python2PackageClient.Get.

type Python2PackageClientListByAutomationAccountOptions added in v0.3.0 

type Python2PackageClientListByAutomationAccountOptions struct {
}

Python2PackageClientListByAutomationAccountOptions contains the optional parameters for the Python2PackageClient.ListByAutomationAccount method.

type Python2PackageClientListByAutomationAccountResponse added in v0.3.0 

type Python2PackageClientListByAutomationAccountResponse struct {
	ModuleListResult
}

Python2PackageClientListByAutomationAccountResponse contains the response from method Python2PackageClient.ListByAutomationAccount.

type Python2PackageClientUpdateOptions added in v0.3.0 

type Python2PackageClientUpdateOptions struct {
}

Python2PackageClientUpdateOptions contains the optional parameters for the Python2PackageClient.Update method.

type Python2PackageClientUpdateResponse added in v0.3.0 

type Python2PackageClientUpdateResponse struct {
	Module
}

Python2PackageClientUpdateResponse contains the response from method Python2PackageClient.Update.

type PythonPackageCreateParameters 

type PythonPackageCreateParameters struct {
	// REQUIRED; Gets or sets the module create properties.
	Properties *PythonPackageCreateProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

PythonPackageCreateParameters - The parameters supplied to the create or update module operation.

func (PythonPackageCreateParameters) MarshalJSON 

func (p PythonPackageCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PythonPackageCreateParameters.

type PythonPackageCreateProperties 

type PythonPackageCreateProperties struct {
	// REQUIRED; Gets or sets the module content link.
	ContentLink *ContentLink `json:"contentLink,omitempty"`
}

PythonPackageCreateProperties - The parameters supplied to the create or update module properties.

type PythonPackageUpdateParameters 

type PythonPackageUpdateParameters struct {
	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

PythonPackageUpdateParameters - The parameters supplied to the update module operation.

func (PythonPackageUpdateParameters) MarshalJSON 

func (p PythonPackageUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PythonPackageUpdateParameters.

type RawGraphicalRunbookContent 

type RawGraphicalRunbookContent struct {
	// Serialized Graphical runbook
	RunbookDefinition *string `json:"runbookDefinition,omitempty"`

	// Runbook Type
	RunbookType *GraphRunbookType `json:"runbookType,omitempty"`

	// Schema version of the serializer.
	SchemaVersion *string `json:"schemaVersion,omitempty"`
}

RawGraphicalRunbookContent - Raw Graphical Runbook content

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - The core properties of ARM resources

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The identity type. 

const (
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

type RunAsCredentialAssociationProperty 

type RunAsCredentialAssociationProperty struct {
	// Gets or sets the name of the credential.
	Name *string `json:"name,omitempty"`
}

RunAsCredentialAssociationProperty - Definition of RunAs credential to use for hybrid worker.

type Runbook 

type Runbook struct {
	// Gets or sets the etag of the resource.
	Etag *string `json:"etag,omitempty"`

	// The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`

	// Gets or sets the runbook properties.
	Properties *RunbookProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Runbook - Definition of the runbook type.

func (Runbook) MarshalJSON 

func (r Runbook) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Runbook.

type RunbookAssociationProperty 

type RunbookAssociationProperty struct {
	// Gets or sets the name of the runbook.
	Name *string `json:"name,omitempty"`
}

RunbookAssociationProperty - The runbook property associated with the entity.

type RunbookClient 

type RunbookClient struct {
	// contains filtered or unexported fields
}

RunbookClient contains the methods for the Runbook group. Don't use this type directly, use NewRunbookClient() instead.

func NewRunbookClient 

func NewRunbookClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RunbookClient, error)

NewRunbookClient creates a new instance of RunbookClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RunbookClient) BeginPublish 

func (client *RunbookClient) BeginPublish(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookClientBeginPublishOptions) (*runtime.Poller[RunbookClientPublishResponse], error)

BeginPublish - Publish runbook draft. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The parameters supplied to the publish runbook operation. options - RunbookClientBeginPublishOptions contains the optional parameters for the RunbookClient.BeginPublish method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/publishRunbook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginPublish(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*RunbookClient) CreateOrUpdate 

func (client *RunbookClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, parameters RunbookCreateOrUpdateParameters, options *RunbookClientCreateOrUpdateOptions) (RunbookClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create the runbook identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. parameters - The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both. options - RunbookClientCreateOrUpdateOptions contains the optional parameters for the RunbookClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/createOrUpdateRunbook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		armautomation.RunbookCreateOrUpdateParameters{
			Name:     to.Ptr("Get-AzureVMTutorial"),
			Location: to.Ptr("East US 2"),
			Properties: &armautomation.RunbookCreateOrUpdateProperties{
				Description:      to.Ptr("Description of the Runbook"),
				LogActivityTrace: to.Ptr[int32](1),
				LogProgress:      to.Ptr(true),
				LogVerbose:       to.Ptr(false),
				PublishContentLink: &armautomation.ContentLink{
					ContentHash: &armautomation.ContentHash{
						Algorithm: to.Ptr("SHA256"),
						Value:     to.Ptr("115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80"),
					},
					URI: to.Ptr("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1"),
				},
				RunbookType: to.Ptr(armautomation.RunbookTypeEnumPowerShellWorkflow),
			},
			Tags: map[string]*string{
				"tag01": to.Ptr("value01"),
				"tag02": to.Ptr("value02"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*RunbookClient) Delete 

func (client *RunbookClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookClientDeleteOptions) (RunbookClientDeleteResponse, error)

Delete - Delete the runbook by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - RunbookClientDeleteOptions contains the optional parameters for the RunbookClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/deleteRunbook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*RunbookClient) Get 

func (client *RunbookClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookClientGetOptions) (RunbookClientGetResponse, error)

Get - Retrieve the runbook identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - RunbookClientGetOptions contains the optional parameters for the RunbookClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*RunbookClient) GetContent 

func (client *RunbookClient) GetContent(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookClientGetContentOptions) (RunbookClientGetContentResponse, error)

GetContent - Retrieve the content of runbook identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - RunbookClientGetContentOptions contains the optional parameters for the RunbookClient.GetContent method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookContent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.GetContent(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*RunbookClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *RunbookClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *RunbookClientListByAutomationAccountOptions) *runtime.Pager[RunbookClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of runbooks. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - RunbookClientListByAutomationAccountOptions contains the optional parameters for the RunbookClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/listRunbooksByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"ContoseAutomationAccount",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*RunbookClient) Update 

func (client *RunbookClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, parameters RunbookUpdateParameters, options *RunbookClientUpdateOptions) (RunbookClientUpdateResponse, error)

Update - Update the runbook identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. parameters - The update parameters for runbook. options - RunbookClientUpdateOptions contains the optional parameters for the RunbookClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/updateRunbook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Update(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		armautomation.RunbookUpdateParameters{
			Properties: &armautomation.RunbookUpdateProperties{
				Description:      to.Ptr("Updated Description of the Runbook"),
				LogActivityTrace: to.Ptr[int32](1),
				LogProgress:      to.Ptr(true),
				LogVerbose:       to.Ptr(false),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type RunbookClientBeginPublishOptions added in v0.3.0 

type RunbookClientBeginPublishOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RunbookClientBeginPublishOptions contains the optional parameters for the RunbookClient.BeginPublish method.

type RunbookClientCreateOrUpdateOptions added in v0.3.0 

type RunbookClientCreateOrUpdateOptions struct {
}

RunbookClientCreateOrUpdateOptions contains the optional parameters for the RunbookClient.CreateOrUpdate method.

type RunbookClientCreateOrUpdateResponse added in v0.3.0 

type RunbookClientCreateOrUpdateResponse struct {
	Runbook
}

RunbookClientCreateOrUpdateResponse contains the response from method RunbookClient.CreateOrUpdate.

type RunbookClientDeleteOptions added in v0.3.0 

type RunbookClientDeleteOptions struct {
}

RunbookClientDeleteOptions contains the optional parameters for the RunbookClient.Delete method.

type RunbookClientDeleteResponse added in v0.3.0 

type RunbookClientDeleteResponse struct {
}

RunbookClientDeleteResponse contains the response from method RunbookClient.Delete.

type RunbookClientGetContentOptions added in v0.3.0 

type RunbookClientGetContentOptions struct {
}

RunbookClientGetContentOptions contains the optional parameters for the RunbookClient.GetContent method.

type RunbookClientGetContentResponse added in v0.3.0 

type RunbookClientGetContentResponse struct {
}

RunbookClientGetContentResponse contains the response from method RunbookClient.GetContent.

type RunbookClientGetOptions added in v0.3.0 

type RunbookClientGetOptions struct {
}

RunbookClientGetOptions contains the optional parameters for the RunbookClient.Get method.

type RunbookClientGetResponse added in v0.3.0 

type RunbookClientGetResponse struct {
	Runbook
}

RunbookClientGetResponse contains the response from method RunbookClient.Get.

type RunbookClientListByAutomationAccountOptions added in v0.3.0 

type RunbookClientListByAutomationAccountOptions struct {
}

RunbookClientListByAutomationAccountOptions contains the optional parameters for the RunbookClient.ListByAutomationAccount method.

type RunbookClientListByAutomationAccountResponse added in v0.3.0 

type RunbookClientListByAutomationAccountResponse struct {
	RunbookListResult
}

RunbookClientListByAutomationAccountResponse contains the response from method RunbookClient.ListByAutomationAccount.

type RunbookClientPublishResponse added in v0.3.0 

type RunbookClientPublishResponse struct {
}

RunbookClientPublishResponse contains the response from method RunbookClient.Publish.

type RunbookClientUpdateOptions added in v0.3.0 

type RunbookClientUpdateOptions struct {
}

RunbookClientUpdateOptions contains the optional parameters for the RunbookClient.Update method.

type RunbookClientUpdateResponse added in v0.3.0 

type RunbookClientUpdateResponse struct {
	Runbook
}

RunbookClientUpdateResponse contains the response from method RunbookClient.Update.

type RunbookCreateOrUpdateDraftParameters 

type RunbookCreateOrUpdateDraftParameters struct {
	// REQUIRED; Content of the Runbook.
	RunbookContent *string `json:"runbookContent,omitempty"`
}

RunbookCreateOrUpdateDraftParameters - The parameters supplied to the create or update runbook operation.

type RunbookCreateOrUpdateDraftProperties 

type RunbookCreateOrUpdateDraftProperties struct {
	// REQUIRED; Gets or sets the draft runbook properties.
	Draft *RunbookDraft `json:"draft,omitempty"`

	// REQUIRED; Gets or sets the type of the runbook.
	RunbookType *RunbookTypeEnum `json:"runbookType,omitempty"`

	// Gets or sets the description of the runbook.
	Description *string `json:"description,omitempty"`

	// Gets or sets the activity-level tracing options of the runbook.
	LogActivityTrace *int32 `json:"logActivityTrace,omitempty"`

	// Gets or sets progress log option.
	LogProgress *bool `json:"logProgress,omitempty"`

	// Gets or sets verbose log option.
	LogVerbose *bool `json:"logVerbose,omitempty"`
}

RunbookCreateOrUpdateDraftProperties - The parameters supplied to the create or update draft runbook properties.

type RunbookCreateOrUpdateParameters 

type RunbookCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets runbook create or update properties.
	Properties *RunbookCreateOrUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets the name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

RunbookCreateOrUpdateParameters - The parameters supplied to the create or update runbook operation.

func (RunbookCreateOrUpdateParameters) MarshalJSON 

func (r RunbookCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RunbookCreateOrUpdateParameters.

type RunbookCreateOrUpdateProperties 

type RunbookCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the type of the runbook.
	RunbookType *RunbookTypeEnum `json:"runbookType,omitempty"`

	// Gets or sets the description of the runbook.
	Description *string `json:"description,omitempty"`

	// Gets or sets the draft runbook properties.
	Draft *RunbookDraft `json:"draft,omitempty"`

	// Gets or sets the activity-level tracing options of the runbook.
	LogActivityTrace *int32 `json:"logActivityTrace,omitempty"`

	// Gets or sets progress log option.
	LogProgress *bool `json:"logProgress,omitempty"`

	// Gets or sets verbose log option.
	LogVerbose *bool `json:"logVerbose,omitempty"`

	// Gets or sets the published runbook content link.
	PublishContentLink *ContentLink `json:"publishContentLink,omitempty"`
}

RunbookCreateOrUpdateProperties - The parameters supplied to the create or update runbook properties.

type RunbookDraft 

type RunbookDraft struct {
	// Gets or sets the creation time of the runbook draft.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the draft runbook content link.
	DraftContentLink *ContentLink `json:"draftContentLink,omitempty"`

	// Gets or sets whether runbook is in edit mode.
	InEdit *bool `json:"inEdit,omitempty"`

	// Gets or sets the last modified time of the runbook draft.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the runbook output types.
	OutputTypes []*string `json:"outputTypes,omitempty"`

	// Gets or sets the runbook draft parameters.
	Parameters map[string]*RunbookParameter `json:"parameters,omitempty"`
}

func (RunbookDraft) MarshalJSON 

func (r RunbookDraft) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RunbookDraft.

func (*RunbookDraft) UnmarshalJSON 

func (r *RunbookDraft) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RunbookDraft.

type RunbookDraftClient 

type RunbookDraftClient struct {
	// contains filtered or unexported fields
}

RunbookDraftClient contains the methods for the RunbookDraft group. Don't use this type directly, use NewRunbookDraftClient() instead.

func NewRunbookDraftClient 

func NewRunbookDraftClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RunbookDraftClient, error)

NewRunbookDraftClient creates a new instance of RunbookDraftClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RunbookDraftClient) BeginReplaceContent 

func (client *RunbookDraftClient) BeginReplaceContent(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, runbookContent io.ReadSeekCloser, options *RunbookDraftClientBeginReplaceContentOptions) (*runtime.Poller[RunbookDraftClientReplaceContentResponse], error)

BeginReplaceContent - Replaces the runbook draft content. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. runbookContent - The runbook draft content. options - RunbookDraftClientBeginReplaceContentOptions contains the optional parameters for the RunbookDraftClient.BeginReplaceContent method.

func (*RunbookDraftClient) Get 

func (client *RunbookDraftClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookDraftClientGetOptions) (RunbookDraftClientGetResponse, error)

Get - Retrieve the runbook draft identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - RunbookDraftClientGetOptions contains the optional parameters for the RunbookDraftClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookDraft.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookDraftClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*RunbookDraftClient) GetContent 

func (client *RunbookDraftClient) GetContent(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookDraftClientGetContentOptions) (RunbookDraftClientGetContentResponse, error)

GetContent - Retrieve the content of runbook draft identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - RunbookDraftClientGetContentOptions contains the optional parameters for the RunbookDraftClient.GetContent method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getRunbookDraftContent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookDraftClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.GetContent(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*RunbookDraftClient) UndoEdit 

func (client *RunbookDraftClient) UndoEdit(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *RunbookDraftClientUndoEditOptions) (RunbookDraftClientUndoEditResponse, error)

UndoEdit - Undo draft edit to last known published state identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - RunbookDraftClientUndoEditOptions contains the optional parameters for the RunbookDraftClient.UndoEdit method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/undoDraftEditToLastKnownPublishedState.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewRunbookDraftClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.UndoEdit(ctx,
		"rg",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type RunbookDraftClientBeginReplaceContentOptions added in v0.3.0 

type RunbookDraftClientBeginReplaceContentOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RunbookDraftClientBeginReplaceContentOptions contains the optional parameters for the RunbookDraftClient.BeginReplaceContent method.

type RunbookDraftClientGetContentOptions added in v0.3.0 

type RunbookDraftClientGetContentOptions struct {
}

RunbookDraftClientGetContentOptions contains the optional parameters for the RunbookDraftClient.GetContent method.

type RunbookDraftClientGetContentResponse added in v0.3.0 

type RunbookDraftClientGetContentResponse struct {
}

RunbookDraftClientGetContentResponse contains the response from method RunbookDraftClient.GetContent.

type RunbookDraftClientGetOptions added in v0.3.0 

type RunbookDraftClientGetOptions struct {
}

RunbookDraftClientGetOptions contains the optional parameters for the RunbookDraftClient.Get method.

type RunbookDraftClientGetResponse added in v0.3.0 

type RunbookDraftClientGetResponse struct {
	RunbookDraft
}

RunbookDraftClientGetResponse contains the response from method RunbookDraftClient.Get.

type RunbookDraftClientReplaceContentResponse added in v0.3.0 

type RunbookDraftClientReplaceContentResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser
}

RunbookDraftClientReplaceContentResponse contains the response from method RunbookDraftClient.ReplaceContent.

func (*RunbookDraftClientReplaceContentResponse) UnmarshalJSON added in v0.4.0 

func (r *RunbookDraftClientReplaceContentResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RunbookDraftClientReplaceContentResponse.

type RunbookDraftClientUndoEditOptions added in v0.3.0 

type RunbookDraftClientUndoEditOptions struct {
}

RunbookDraftClientUndoEditOptions contains the optional parameters for the RunbookDraftClient.UndoEdit method.

type RunbookDraftClientUndoEditResponse added in v0.3.0 

type RunbookDraftClientUndoEditResponse struct {
	RunbookDraftUndoEditResult
}

RunbookDraftClientUndoEditResponse contains the response from method RunbookDraftClient.UndoEdit.

type RunbookDraftUndoEditResult 

type RunbookDraftUndoEditResult struct {
	RequestID  *string         `json:"requestId,omitempty"`
	StatusCode *HTTPStatusCode `json:"statusCode,omitempty"`
}

RunbookDraftUndoEditResult - The response model for the undo edit runbook operation.

type RunbookListResult 

type RunbookListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of runbooks.
	Value []*Runbook `json:"value,omitempty"`
}

RunbookListResult - The response model for the list runbook operation.

type RunbookParameter 

type RunbookParameter struct {
	// Gets or sets the default value of parameter.
	DefaultValue *string `json:"defaultValue,omitempty"`

	// Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
	IsMandatory *bool `json:"isMandatory,omitempty"`

	// Get or sets the position of the parameter.
	Position *int32 `json:"position,omitempty"`

	// Gets or sets the type of the parameter.
	Type *string `json:"type,omitempty"`
}

RunbookParameter - Definition of the runbook parameter type.

type RunbookProperties 

type RunbookProperties struct {
	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the draft runbook properties.
	Draft *RunbookDraft `json:"draft,omitempty"`

	// Gets or sets the job count of the runbook.
	JobCount *int32 `json:"jobCount,omitempty"`

	// Gets or sets the last modified by.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the option to log activity trace of the runbook.
	LogActivityTrace *int32 `json:"logActivityTrace,omitempty"`

	// Gets or sets progress log option.
	LogProgress *bool `json:"logProgress,omitempty"`

	// Gets or sets verbose log option.
	LogVerbose *bool `json:"logVerbose,omitempty"`

	// Gets or sets the runbook output types.
	OutputTypes []*string `json:"outputTypes,omitempty"`

	// Gets or sets the runbook parameters.
	Parameters map[string]*RunbookParameter `json:"parameters,omitempty"`

	// Gets or sets the provisioning state of the runbook.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Gets or sets the published runbook content link.
	PublishContentLink *ContentLink `json:"publishContentLink,omitempty"`

	// Gets or sets the type of the runbook.
	RunbookType *RunbookTypeEnum `json:"runbookType,omitempty"`

	// Gets or sets the state of the runbook.
	State *RunbookState `json:"state,omitempty"`
}

RunbookProperties - Definition of the runbook property type.

func (RunbookProperties) MarshalJSON 

func (r RunbookProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RunbookProperties.

func (*RunbookProperties) UnmarshalJSON 

func (r *RunbookProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RunbookProperties.

type RunbookState 

type RunbookState string

RunbookState - Gets or sets the state of the runbook. 

const (
	RunbookStateEdit      RunbookState = "Edit"
	RunbookStateNew       RunbookState = "New"
	RunbookStatePublished RunbookState = "Published"
)

func PossibleRunbookStateValues 

func PossibleRunbookStateValues() []RunbookState

PossibleRunbookStateValues returns the possible values for the RunbookState const type.

type RunbookTypeEnum 

type RunbookTypeEnum string

RunbookTypeEnum - Gets or sets the type of the runbook. 

const (
	RunbookTypeEnumGraph                   RunbookTypeEnum = "Graph"
	RunbookTypeEnumGraphPowerShell         RunbookTypeEnum = "GraphPowerShell"
	RunbookTypeEnumGraphPowerShellWorkflow RunbookTypeEnum = "GraphPowerShellWorkflow"
	RunbookTypeEnumPowerShell              RunbookTypeEnum = "PowerShell"
	RunbookTypeEnumPowerShellWorkflow      RunbookTypeEnum = "PowerShellWorkflow"
	RunbookTypeEnumScript                  RunbookTypeEnum = "Script"
)

func PossibleRunbookTypeEnumValues 

func PossibleRunbookTypeEnumValues() []RunbookTypeEnum

PossibleRunbookTypeEnumValues returns the possible values for the RunbookTypeEnum const type.

type RunbookUpdateParameters 

type RunbookUpdateParameters struct {
	// Gets or sets the location of the resource.
	Location *string `json:"location,omitempty"`

	// Gets or sets the name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the runbook update properties.
	Properties *RunbookUpdateProperties `json:"properties,omitempty"`

	// Gets or sets the tags attached to the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

RunbookUpdateParameters - The parameters supplied to the update runbook operation.

func (RunbookUpdateParameters) MarshalJSON 

func (r RunbookUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RunbookUpdateParameters.

type RunbookUpdateProperties 

type RunbookUpdateProperties struct {
	// Gets or sets the description of the runbook.
	Description *string `json:"description,omitempty"`

	// Gets or sets the activity-level tracing options of the runbook.
	LogActivityTrace *int32 `json:"logActivityTrace,omitempty"`

	// Gets or sets progress log option.
	LogProgress *bool `json:"logProgress,omitempty"`

	// Gets or sets verbose log option.
	LogVerbose *bool `json:"logVerbose,omitempty"`
}

RunbookUpdateProperties - The parameters supplied to the update runbook properties.

type SKU 

type SKU struct {
	// REQUIRED; Gets or sets the SKU name of the account.
	Name *SKUNameEnum `json:"name,omitempty"`

	// Gets or sets the SKU capacity.
	Capacity *int32 `json:"capacity,omitempty"`

	// Gets or sets the SKU family.
	Family *string `json:"family,omitempty"`
}

SKU - The account SKU.

type SKUNameEnum 

type SKUNameEnum string

SKUNameEnum - Gets or sets the SKU name of the account. 

const (
	SKUNameEnumBasic SKUNameEnum = "Basic"
	SKUNameEnumFree  SKUNameEnum = "Free"
)

func PossibleSKUNameEnumValues 

func PossibleSKUNameEnumValues() []SKUNameEnum

PossibleSKUNameEnumValues returns the possible values for the SKUNameEnum const type.

type SUCScheduleProperties 

type SUCScheduleProperties struct {
	// Gets or sets the advanced schedule.
	AdvancedSchedule *AdvancedSchedule `json:"advancedSchedule,omitempty"`

	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the end time of the schedule.
	ExpiryTime *time.Time `json:"expiryTime,omitempty"`

	// Gets or sets the expiry time's offset in minutes.
	ExpiryTimeOffsetMinutes *float64 `json:"expiryTimeOffsetMinutes,omitempty"`

	// Gets or sets the frequency of the schedule.
	Frequency *ScheduleFrequency `json:"frequency,omitempty"`

	// Gets or sets the interval of the schedule.
	Interval *int64 `json:"interval,omitempty"`

	// Gets or sets a value indicating whether this schedule is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the next run time of the schedule.
	NextRun *time.Time `json:"nextRun,omitempty"`

	// Gets or sets the next run time's offset in minutes.
	NextRunOffsetMinutes *float64 `json:"nextRunOffsetMinutes,omitempty"`

	// Gets or sets the start time of the schedule.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Gets or sets the time zone of the schedule.
	TimeZone *string `json:"timeZone,omitempty"`

	// READ-ONLY; Gets the start time's offset in minutes.
	StartTimeOffsetMinutes *float64 `json:"startTimeOffsetMinutes,omitempty" azure:"ro"`
}

SUCScheduleProperties - Definition of schedule parameters.

func (SUCScheduleProperties) MarshalJSON 

func (s SUCScheduleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SUCScheduleProperties.

func (*SUCScheduleProperties) UnmarshalJSON 

func (s *SUCScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SUCScheduleProperties.

type Schedule 

type Schedule struct {
	// Gets or sets the properties of the schedule.
	Properties *ScheduleProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Schedule - Definition of the schedule.

type ScheduleAssociationProperty 

type ScheduleAssociationProperty struct {
	// Gets or sets the name of the Schedule.
	Name *string `json:"name,omitempty"`
}

ScheduleAssociationProperty - The schedule property associated with the entity.

type ScheduleClient 

type ScheduleClient struct {
	// contains filtered or unexported fields
}

ScheduleClient contains the methods for the Schedule group. Don't use this type directly, use NewScheduleClient() instead.

func NewScheduleClient 

func NewScheduleClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ScheduleClient, error)

NewScheduleClient creates a new instance of ScheduleClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ScheduleClient) CreateOrUpdate 

func (client *ScheduleClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, scheduleName string, parameters ScheduleCreateOrUpdateParameters, options *ScheduleClientCreateOrUpdateOptions) (ScheduleClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a schedule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. scheduleName - The schedule name. parameters - The parameters supplied to the create or update schedule operation. options - ScheduleClientCreateOrUpdateOptions contains the optional parameters for the ScheduleClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateSchedule.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount33",
		"mySchedule",
		armautomation.ScheduleCreateOrUpdateParameters{
			Name: to.Ptr("mySchedule"),
			Properties: &armautomation.ScheduleCreateOrUpdateProperties{
				Description:      to.Ptr("my description of schedule goes here"),
				AdvancedSchedule: &armautomation.AdvancedSchedule{},
				ExpiryTime:       to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-01T17:28:57.2494819Z"); return t }()),
				Frequency:        to.Ptr(armautomation.ScheduleFrequencyHour),
				Interval:         float64(1),
				StartTime:        to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-27T17:28:57.2494819Z"); return t }()),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ScheduleClient) Delete 

func (client *ScheduleClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, scheduleName string, options *ScheduleClientDeleteOptions) (ScheduleClientDeleteResponse, error)

Delete - Delete the schedule identified by schedule name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. scheduleName - The schedule name. options - ScheduleClientDeleteOptions contains the optional parameters for the ScheduleClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteSchedule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount33",
		"mySchedule",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ScheduleClient) Get 

func (client *ScheduleClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, scheduleName string, options *ScheduleClientGetOptions) (ScheduleClientGetResponse, error)

Get - Retrieve the schedule identified by schedule name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. scheduleName - The schedule name. options - ScheduleClientGetOptions contains the optional parameters for the ScheduleClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getSchedule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"mySchedule",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*ScheduleClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *ScheduleClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *ScheduleClientListByAutomationAccountOptions) *runtime.Pager[ScheduleClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of schedules. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - ScheduleClientListByAutomationAccountOptions contains the optional parameters for the ScheduleClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listSchedulesByAutomationAccount_First100.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*ScheduleClient) Update 

func (client *ScheduleClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, scheduleName string, parameters ScheduleUpdateParameters, options *ScheduleClientUpdateOptions) (ScheduleClientUpdateResponse, error)

Update - Update the schedule identified by schedule name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. scheduleName - The schedule name. parameters - The parameters supplied to the update schedule operation. options - ScheduleClientUpdateOptions contains the optional parameters for the ScheduleClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateSchedule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewScheduleClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount33",
		"mySchedule",
		armautomation.ScheduleUpdateParameters{
			Name: to.Ptr("mySchedule"),
			Properties: &armautomation.ScheduleUpdateProperties{
				Description: to.Ptr("my updated description of schedule goes here"),
				IsEnabled:   to.Ptr(false),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type ScheduleClientCreateOrUpdateOptions added in v0.3.0 

type ScheduleClientCreateOrUpdateOptions struct {
}

ScheduleClientCreateOrUpdateOptions contains the optional parameters for the ScheduleClient.CreateOrUpdate method.

type ScheduleClientCreateOrUpdateResponse added in v0.3.0 

type ScheduleClientCreateOrUpdateResponse struct {
	Schedule
}

ScheduleClientCreateOrUpdateResponse contains the response from method ScheduleClient.CreateOrUpdate.

type ScheduleClientDeleteOptions added in v0.3.0 

type ScheduleClientDeleteOptions struct {
}

ScheduleClientDeleteOptions contains the optional parameters for the ScheduleClient.Delete method.

type ScheduleClientDeleteResponse added in v0.3.0 

type ScheduleClientDeleteResponse struct {
}

ScheduleClientDeleteResponse contains the response from method ScheduleClient.Delete.

type ScheduleClientGetOptions added in v0.3.0 

type ScheduleClientGetOptions struct {
}

ScheduleClientGetOptions contains the optional parameters for the ScheduleClient.Get method.

type ScheduleClientGetResponse added in v0.3.0 

type ScheduleClientGetResponse struct {
	Schedule
}

ScheduleClientGetResponse contains the response from method ScheduleClient.Get.

type ScheduleClientListByAutomationAccountOptions added in v0.3.0 

type ScheduleClientListByAutomationAccountOptions struct {
}

ScheduleClientListByAutomationAccountOptions contains the optional parameters for the ScheduleClient.ListByAutomationAccount method.

type ScheduleClientListByAutomationAccountResponse added in v0.3.0 

type ScheduleClientListByAutomationAccountResponse struct {
	ScheduleListResult
}

ScheduleClientListByAutomationAccountResponse contains the response from method ScheduleClient.ListByAutomationAccount.

type ScheduleClientUpdateOptions added in v0.3.0 

type ScheduleClientUpdateOptions struct {
}

ScheduleClientUpdateOptions contains the optional parameters for the ScheduleClient.Update method.

type ScheduleClientUpdateResponse added in v0.3.0 

type ScheduleClientUpdateResponse struct {
	Schedule
}

ScheduleClientUpdateResponse contains the response from method ScheduleClient.Update.

type ScheduleCreateOrUpdateParameters 

type ScheduleCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the Schedule.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the list of schedule properties.
	Properties *ScheduleCreateOrUpdateProperties `json:"properties,omitempty"`
}

ScheduleCreateOrUpdateParameters - The parameters supplied to the create or update schedule operation.

type ScheduleCreateOrUpdateProperties 

type ScheduleCreateOrUpdateProperties struct {
	// REQUIRED; Gets or sets the frequency of the schedule.
	Frequency *ScheduleFrequency `json:"frequency,omitempty"`

	// REQUIRED; Gets or sets the start time of the schedule.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Gets or sets the AdvancedSchedule.
	AdvancedSchedule *AdvancedSchedule `json:"advancedSchedule,omitempty"`

	// Gets or sets the description of the schedule.
	Description *string `json:"description,omitempty"`

	// Gets or sets the end time of the schedule.
	ExpiryTime *time.Time `json:"expiryTime,omitempty"`

	// Gets or sets the interval of the schedule.
	Interval interface{} `json:"interval,omitempty"`

	// Gets or sets the time zone of the schedule.
	TimeZone *string `json:"timeZone,omitempty"`
}

ScheduleCreateOrUpdateProperties - The parameters supplied to the create or update schedule operation.

func (ScheduleCreateOrUpdateProperties) MarshalJSON 

func (s ScheduleCreateOrUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScheduleCreateOrUpdateProperties.

func (*ScheduleCreateOrUpdateProperties) UnmarshalJSON 

func (s *ScheduleCreateOrUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleCreateOrUpdateProperties.

type ScheduleDay 

type ScheduleDay string

ScheduleDay - Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. 

const (
	ScheduleDayFriday    ScheduleDay = "Friday"
	ScheduleDayMonday    ScheduleDay = "Monday"
	ScheduleDaySaturday  ScheduleDay = "Saturday"
	ScheduleDaySunday    ScheduleDay = "Sunday"
	ScheduleDayThursday  ScheduleDay = "Thursday"
	ScheduleDayTuesday   ScheduleDay = "Tuesday"
	ScheduleDayWednesday ScheduleDay = "Wednesday"
)

func PossibleScheduleDayValues 

func PossibleScheduleDayValues() []ScheduleDay

PossibleScheduleDayValues returns the possible values for the ScheduleDay const type.

type ScheduleFrequency 

type ScheduleFrequency string

ScheduleFrequency - Gets or sets the frequency of the schedule. 

const (
	ScheduleFrequencyDay  ScheduleFrequency = "Day"
	ScheduleFrequencyHour ScheduleFrequency = "Hour"
	// ScheduleFrequencyMinute - The minimum allowed interval for Minute schedules is 15 minutes.
	ScheduleFrequencyMinute  ScheduleFrequency = "Minute"
	ScheduleFrequencyMonth   ScheduleFrequency = "Month"
	ScheduleFrequencyOneTime ScheduleFrequency = "OneTime"
	ScheduleFrequencyWeek    ScheduleFrequency = "Week"
)

func PossibleScheduleFrequencyValues 

func PossibleScheduleFrequencyValues() []ScheduleFrequency

PossibleScheduleFrequencyValues returns the possible values for the ScheduleFrequency const type.

type ScheduleListResult 

type ScheduleListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of schedules.
	Value []*Schedule `json:"value,omitempty"`
}

ScheduleListResult - The response model for the list schedule operation.

type ScheduleProperties 

type ScheduleProperties struct {
	// Gets or sets the advanced schedule.
	AdvancedSchedule *AdvancedSchedule `json:"advancedSchedule,omitempty"`

	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the end time of the schedule.
	ExpiryTime *time.Time `json:"expiryTime,omitempty"`

	// Gets or sets the expiry time's offset in minutes.
	ExpiryTimeOffsetMinutes *float64 `json:"expiryTimeOffsetMinutes,omitempty"`

	// Gets or sets the frequency of the schedule.
	Frequency *ScheduleFrequency `json:"frequency,omitempty"`

	// Gets or sets the interval of the schedule.
	Interval interface{} `json:"interval,omitempty"`

	// Gets or sets a value indicating whether this schedule is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the next run time of the schedule.
	NextRun *time.Time `json:"nextRun,omitempty"`

	// Gets or sets the next run time's offset in minutes.
	NextRunOffsetMinutes *float64 `json:"nextRunOffsetMinutes,omitempty"`

	// Gets or sets the start time of the schedule.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Gets or sets the time zone of the schedule.
	TimeZone *string `json:"timeZone,omitempty"`

	// READ-ONLY; Gets the start time's offset in minutes.
	StartTimeOffsetMinutes *float64 `json:"startTimeOffsetMinutes,omitempty" azure:"ro"`
}

ScheduleProperties - Definition of schedule parameters.

func (ScheduleProperties) MarshalJSON 

func (s ScheduleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScheduleProperties.

func (*ScheduleProperties) UnmarshalJSON 

func (s *ScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleProperties.

type ScheduleUpdateParameters 

type ScheduleUpdateParameters struct {
	// Gets or sets the name of the Schedule.
	Name *string `json:"name,omitempty"`

	// Gets or sets the list of schedule properties.
	Properties *ScheduleUpdateProperties `json:"properties,omitempty"`
}

ScheduleUpdateParameters - The parameters supplied to the update schedule operation.

func (ScheduleUpdateParameters) MarshalJSON 

func (s ScheduleUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScheduleUpdateParameters.

type ScheduleUpdateProperties 

type ScheduleUpdateProperties struct {
	// Gets or sets the description of the schedule.
	Description *string `json:"description,omitempty"`

	// Gets or sets a value indicating whether this schedule is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`
}

ScheduleUpdateProperties - The parameters supplied to the update schedule operation.

type SoftwareUpdateConfiguration 

type SoftwareUpdateConfiguration struct {
	// REQUIRED; Software update configuration properties.
	Properties *SoftwareUpdateConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

SoftwareUpdateConfiguration - Software update configuration properties.

type SoftwareUpdateConfigurationCollectionItem 

type SoftwareUpdateConfigurationCollectionItem struct {
	// REQUIRED; Software update configuration properties.
	Properties *SoftwareUpdateConfigurationCollectionItemProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id of the software update configuration
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the software update configuration.
	Name *string `json:"name,omitempty" azure:"ro"`
}

SoftwareUpdateConfigurationCollectionItem - Software update configuration collection item properties.

type SoftwareUpdateConfigurationCollectionItemProperties 

type SoftwareUpdateConfigurationCollectionItemProperties struct {
	// execution frequency of the schedule associated with the software update configuration
	Frequency *ScheduleFrequency `json:"frequency,omitempty"`

	// ext run time of the update.
	NextRun *time.Time `json:"nextRun,omitempty"`

	// the start time of the update.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Pre and Post Tasks defined
	Tasks *SoftwareUpdateConfigurationTasks `json:"tasks,omitempty"`

	// Update specific properties of the software update configuration.
	UpdateConfiguration *UpdateConfiguration `json:"updateConfiguration,omitempty"`

	// READ-ONLY; Creation time of the software update configuration, which only appears in the response.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Last time software update configuration was modified, which only appears in the response.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state for the software update configuration, which only appears in the response.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SoftwareUpdateConfigurationCollectionItemProperties - Software update configuration collection item properties.

func (*SoftwareUpdateConfigurationCollectionItemProperties) UnmarshalJSON 

func (s *SoftwareUpdateConfigurationCollectionItemProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftwareUpdateConfigurationCollectionItemProperties.

type SoftwareUpdateConfigurationListResult 

type SoftwareUpdateConfigurationListResult struct {
	// outer object returned when listing all software update configurations
	Value []*SoftwareUpdateConfigurationCollectionItem `json:"value,omitempty"`
}

SoftwareUpdateConfigurationListResult - result of listing all software update configuration

type SoftwareUpdateConfigurationMachineRun 

type SoftwareUpdateConfigurationMachineRun struct {
	// Software update configuration machine run properties.
	Properties *UpdateConfigurationMachineRunProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id of the software update configuration machine run
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the software update configuration machine run
	Name *string `json:"name,omitempty" azure:"ro"`
}

SoftwareUpdateConfigurationMachineRun - Software update configuration machine run model.

type SoftwareUpdateConfigurationMachineRunListResult 

type SoftwareUpdateConfigurationMachineRunListResult struct {
	// link to next page of results.
	NextLink *string `json:"nextLink,omitempty"`

	// outer object returned when listing all software update configuration machine runs
	Value []*SoftwareUpdateConfigurationMachineRun `json:"value,omitempty"`
}

SoftwareUpdateConfigurationMachineRunListResult - result of listing all software update configuration machine runs

type SoftwareUpdateConfigurationMachineRunsClient 

type SoftwareUpdateConfigurationMachineRunsClient struct {
	// contains filtered or unexported fields
}

SoftwareUpdateConfigurationMachineRunsClient contains the methods for the SoftwareUpdateConfigurationMachineRuns group. Don't use this type directly, use NewSoftwareUpdateConfigurationMachineRunsClient() instead.

func NewSoftwareUpdateConfigurationMachineRunsClient 

func NewSoftwareUpdateConfigurationMachineRunsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SoftwareUpdateConfigurationMachineRunsClient, error)

NewSoftwareUpdateConfigurationMachineRunsClient creates a new instance of SoftwareUpdateConfigurationMachineRunsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SoftwareUpdateConfigurationMachineRunsClient) GetByID 

func (client *SoftwareUpdateConfigurationMachineRunsClient) GetByID(ctx context.Context, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationMachineRunID string, options *SoftwareUpdateConfigurationMachineRunsClientGetByIDOptions) (SoftwareUpdateConfigurationMachineRunsClientGetByIDResponse, error)

GetByID - Get a single software update configuration machine run by Id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. softwareUpdateConfigurationMachineRunID - The Id of the software update configuration machine run. options - SoftwareUpdateConfigurationMachineRunsClientGetByIDOptions contains the optional parameters for the SoftwareUpdateConfigurationMachineRunsClient.GetByID method.

func (*SoftwareUpdateConfigurationMachineRunsClient) List 

func (client *SoftwareUpdateConfigurationMachineRunsClient) List(ctx context.Context, resourceGroupName string, automationAccountName string, options *SoftwareUpdateConfigurationMachineRunsClientListOptions) (SoftwareUpdateConfigurationMachineRunsClientListResponse, error)

List - Return list of software update configuration machine runs If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - SoftwareUpdateConfigurationMachineRunsClientListOptions contains the optional parameters for the SoftwareUpdateConfigurationMachineRunsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationMachineRunsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"mygroup",
		"myaccount",
		&armautomation.SoftwareUpdateConfigurationMachineRunsClientListOptions{ClientRequestID: nil,
			Filter: nil,
			Skip:   nil,
			Top:    nil,
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type SoftwareUpdateConfigurationMachineRunsClientGetByIDOptions added in v0.3.0 

type SoftwareUpdateConfigurationMachineRunsClientGetByIDOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

SoftwareUpdateConfigurationMachineRunsClientGetByIDOptions contains the optional parameters for the SoftwareUpdateConfigurationMachineRunsClient.GetByID method.

type SoftwareUpdateConfigurationMachineRunsClientGetByIDResponse added in v0.3.0 

type SoftwareUpdateConfigurationMachineRunsClientGetByIDResponse struct {
	SoftwareUpdateConfigurationMachineRun
}

SoftwareUpdateConfigurationMachineRunsClientGetByIDResponse contains the response from method SoftwareUpdateConfigurationMachineRunsClient.GetByID.

type SoftwareUpdateConfigurationMachineRunsClientListOptions added in v0.3.0 

type SoftwareUpdateConfigurationMachineRunsClientListOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
	// The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime',
	// and 'properties/softwareUpdateConfiguration/name'
	Filter *string
	// number of entries you skip before returning results
	Skip *string
	// Maximum number of entries returned in the results collection
	Top *string
}

SoftwareUpdateConfigurationMachineRunsClientListOptions contains the optional parameters for the SoftwareUpdateConfigurationMachineRunsClient.List method.

type SoftwareUpdateConfigurationMachineRunsClientListResponse added in v0.3.0 

type SoftwareUpdateConfigurationMachineRunsClientListResponse struct {
	SoftwareUpdateConfigurationMachineRunListResult
}

SoftwareUpdateConfigurationMachineRunsClientListResponse contains the response from method SoftwareUpdateConfigurationMachineRunsClient.List.

type SoftwareUpdateConfigurationProperties 

type SoftwareUpdateConfigurationProperties struct {
	// REQUIRED; Schedule information for the Software update configuration
	ScheduleInfo *SUCScheduleProperties `json:"scheduleInfo,omitempty"`

	// REQUIRED; update specific properties for the Software update configuration
	UpdateConfiguration *UpdateConfiguration `json:"updateConfiguration,omitempty"`

	// Details of provisioning error
	Error *ErrorResponse `json:"error,omitempty"`

	// Tasks information for the Software update configuration.
	Tasks *SoftwareUpdateConfigurationTasks `json:"tasks,omitempty"`

	// READ-ONLY; CreatedBy property, which only appears in the response.
	CreatedBy *string `json:"createdBy,omitempty" azure:"ro"`

	// READ-ONLY; Creation time of the resource, which only appears in the response.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; LastModifiedBy property, which only appears in the response.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; Last time resource was modified, which only appears in the response.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state for the software update configuration, which only appears in the response.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

SoftwareUpdateConfigurationProperties - Software update configuration properties.

func (SoftwareUpdateConfigurationProperties) MarshalJSON 

func (s SoftwareUpdateConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SoftwareUpdateConfigurationProperties.

func (*SoftwareUpdateConfigurationProperties) UnmarshalJSON 

func (s *SoftwareUpdateConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftwareUpdateConfigurationProperties.

type SoftwareUpdateConfigurationRun 

type SoftwareUpdateConfigurationRun struct {
	// Software update configuration Run properties.
	Properties *SoftwareUpdateConfigurationRunProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource Id of the software update configuration run
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the software update configuration run.
	Name *string `json:"name,omitempty" azure:"ro"`
}

SoftwareUpdateConfigurationRun - Software update configuration Run properties.

type SoftwareUpdateConfigurationRunListResult 

type SoftwareUpdateConfigurationRunListResult struct {
	// link to next page of results.
	NextLink *string `json:"nextLink,omitempty"`

	// outer object returned when listing all software update configuration runs
	Value []*SoftwareUpdateConfigurationRun `json:"value,omitempty"`
}

SoftwareUpdateConfigurationRunListResult - result of listing all software update configuration runs

type SoftwareUpdateConfigurationRunProperties 

type SoftwareUpdateConfigurationRunProperties struct {
	// software update configuration triggered this run
	SoftwareUpdateConfiguration *UpdateConfigurationNavigation `json:"softwareUpdateConfiguration,omitempty"`

	// Software update configuration tasks triggered in this run
	Tasks *SoftwareUpdateConfigurationRunTasks `json:"tasks,omitempty"`

	// READ-ONLY; Number of computers in the software update configuration run.
	ComputerCount *int32 `json:"computerCount,omitempty" azure:"ro"`

	// READ-ONLY; Configured duration for the software update configuration run.
	ConfiguredDuration *string `json:"configuredDuration,omitempty" azure:"ro"`

	// READ-ONLY; CreatedBy property, which only appears in the response.
	CreatedBy *string `json:"createdBy,omitempty" azure:"ro"`

	// READ-ONLY; Creation time of the resource, which only appears in the response.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; End time of the software update configuration run.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; Number of computers with failed status.
	FailedCount *int32 `json:"failedCount,omitempty" azure:"ro"`

	// READ-ONLY; LastModifiedBy property, which only appears in the response.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; Last time resource was modified, which only appears in the response.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Operating system target of the software update configuration triggered this run
	OSType *string `json:"osType,omitempty" azure:"ro"`

	// READ-ONLY; Start time of the software update configuration run.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; Status of the software update configuration run.
	Status *string `json:"status,omitempty" azure:"ro"`
}

SoftwareUpdateConfigurationRunProperties - Software update configuration properties.

func (*SoftwareUpdateConfigurationRunProperties) UnmarshalJSON 

func (s *SoftwareUpdateConfigurationRunProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SoftwareUpdateConfigurationRunProperties.

type SoftwareUpdateConfigurationRunTaskProperties 

type SoftwareUpdateConfigurationRunTaskProperties struct {
	// The job id of the task.
	JobID *string `json:"jobId,omitempty"`

	// The name of the source of the task.
	Source *string `json:"source,omitempty"`

	// The status of the task.
	Status *string `json:"status,omitempty"`
}

SoftwareUpdateConfigurationRunTaskProperties - Task properties of the software update configuration.

type SoftwareUpdateConfigurationRunTasks 

type SoftwareUpdateConfigurationRunTasks struct {
	// Post task properties.
	PostTask *SoftwareUpdateConfigurationRunTaskProperties `json:"postTask,omitempty"`

	// Pre task properties.
	PreTask *SoftwareUpdateConfigurationRunTaskProperties `json:"preTask,omitempty"`
}

SoftwareUpdateConfigurationRunTasks - Software update configuration run tasks model.

type SoftwareUpdateConfigurationRunsClient 

type SoftwareUpdateConfigurationRunsClient struct {
	// contains filtered or unexported fields
}

SoftwareUpdateConfigurationRunsClient contains the methods for the SoftwareUpdateConfigurationRuns group. Don't use this type directly, use NewSoftwareUpdateConfigurationRunsClient() instead.

func NewSoftwareUpdateConfigurationRunsClient 

func NewSoftwareUpdateConfigurationRunsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SoftwareUpdateConfigurationRunsClient, error)

NewSoftwareUpdateConfigurationRunsClient creates a new instance of SoftwareUpdateConfigurationRunsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SoftwareUpdateConfigurationRunsClient) GetByID 

func (client *SoftwareUpdateConfigurationRunsClient) GetByID(ctx context.Context, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationRunID string, options *SoftwareUpdateConfigurationRunsClientGetByIDOptions) (SoftwareUpdateConfigurationRunsClientGetByIDResponse, error)

GetByID - Get a single software update configuration Run by Id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. softwareUpdateConfigurationRunID - The Id of the software update configuration run. options - SoftwareUpdateConfigurationRunsClientGetByIDOptions contains the optional parameters for the SoftwareUpdateConfigurationRunsClient.GetByID method.

func (*SoftwareUpdateConfigurationRunsClient) List 

func (client *SoftwareUpdateConfigurationRunsClient) List(ctx context.Context, resourceGroupName string, automationAccountName string, options *SoftwareUpdateConfigurationRunsClientListOptions) (SoftwareUpdateConfigurationRunsClientListResponse, error)

List - Return list of software update configuration runs If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - SoftwareUpdateConfigurationRunsClientListOptions contains the optional parameters for the SoftwareUpdateConfigurationRunsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationRunsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"mygroup",
		"myaccount",
		&armautomation.SoftwareUpdateConfigurationRunsClientListOptions{ClientRequestID: nil,
			Filter: to.Ptr("properties/status%20eq%20'Failed'"),
			Skip:   nil,
			Top:    nil,
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type SoftwareUpdateConfigurationRunsClientGetByIDOptions added in v0.3.0 

type SoftwareUpdateConfigurationRunsClientGetByIDOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

SoftwareUpdateConfigurationRunsClientGetByIDOptions contains the optional parameters for the SoftwareUpdateConfigurationRunsClient.GetByID method.

type SoftwareUpdateConfigurationRunsClientGetByIDResponse added in v0.3.0 

type SoftwareUpdateConfigurationRunsClientGetByIDResponse struct {
	SoftwareUpdateConfigurationRun
}

SoftwareUpdateConfigurationRunsClientGetByIDResponse contains the response from method SoftwareUpdateConfigurationRunsClient.GetByID.

type SoftwareUpdateConfigurationRunsClientListOptions added in v0.3.0 

type SoftwareUpdateConfigurationRunsClientListOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
	// The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime',
	// and 'properties/softwareUpdateConfiguration/name'
	Filter *string
	// Number of entries you skip before returning results
	Skip *string
	// Maximum number of entries returned in the results collection
	Top *string
}

SoftwareUpdateConfigurationRunsClientListOptions contains the optional parameters for the SoftwareUpdateConfigurationRunsClient.List method.

type SoftwareUpdateConfigurationRunsClientListResponse added in v0.3.0 

type SoftwareUpdateConfigurationRunsClientListResponse struct {
	SoftwareUpdateConfigurationRunListResult
}

SoftwareUpdateConfigurationRunsClientListResponse contains the response from method SoftwareUpdateConfigurationRunsClient.List.

type SoftwareUpdateConfigurationTasks 

type SoftwareUpdateConfigurationTasks struct {
	// Post task properties.
	PostTask *TaskProperties `json:"postTask,omitempty"`

	// Pre task properties.
	PreTask *TaskProperties `json:"preTask,omitempty"`
}

SoftwareUpdateConfigurationTasks - Task properties of the software update configuration.

type SoftwareUpdateConfigurationsClient 

type SoftwareUpdateConfigurationsClient struct {
	// contains filtered or unexported fields
}

SoftwareUpdateConfigurationsClient contains the methods for the SoftwareUpdateConfigurations group. Don't use this type directly, use NewSoftwareUpdateConfigurationsClient() instead.

func NewSoftwareUpdateConfigurationsClient 

func NewSoftwareUpdateConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SoftwareUpdateConfigurationsClient, error)

NewSoftwareUpdateConfigurationsClient creates a new instance of SoftwareUpdateConfigurationsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SoftwareUpdateConfigurationsClient) Create 

func (client *SoftwareUpdateConfigurationsClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationName string, parameters SoftwareUpdateConfiguration, options *SoftwareUpdateConfigurationsClientCreateOptions) (SoftwareUpdateConfigurationsClientCreateResponse, error)

Create - Create a new software update configuration with the name given in the URI. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. softwareUpdateConfigurationName - The name of the software update configuration to be created. parameters - Request body. options - SoftwareUpdateConfigurationsClientCreateOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"mygroup",
		"myaccount",
		"testpatch",
		armautomation.SoftwareUpdateConfiguration{
			Properties: &armautomation.SoftwareUpdateConfigurationProperties{
				ScheduleInfo: &armautomation.SUCScheduleProperties{
					AdvancedSchedule: &armautomation.AdvancedSchedule{
						WeekDays: []*string{
							to.Ptr("Monday"),
							to.Ptr("Thursday")},
					},
					ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-09T11:22:57+00:00"); return t }()),
					Frequency:  to.Ptr(armautomation.ScheduleFrequencyHour),
					Interval:   to.Ptr[int64](1),
					StartTime:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-19T12:22:57+00:00"); return t }()),
					TimeZone:   to.Ptr("America/Los_Angeles"),
				},
				Tasks: &armautomation.SoftwareUpdateConfigurationTasks{
					PostTask: &armautomation.TaskProperties{
						Source: to.Ptr("GetCache"),
					},
					PreTask: &armautomation.TaskProperties{
						Parameters: map[string]*string{
							"COMPUTERNAME": to.Ptr("Computer1"),
						},
						Source: to.Ptr("HelloWorld"),
					},
				},
				UpdateConfiguration: &armautomation.UpdateConfiguration{
					AzureVirtualMachines: []*string{
						to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01"),
						to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02"),
						to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03")},
					Duration: to.Ptr("PT2H0M"),
					NonAzureComputerNames: []*string{
						to.Ptr("box1.contoso.com"),
						to.Ptr("box2.contoso.com")},
					OperatingSystem: to.Ptr(armautomation.OperatingSystemTypeWindows),
					Targets: &armautomation.TargetProperties{
						AzureQueries: []*armautomation.AzureQueryProperties{
							{
								Locations: []*string{
									to.Ptr("Japan East"),
									to.Ptr("UK South")},
								Scope: []*string{
									to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources"),
									to.Ptr("/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067")},
								TagSettings: &armautomation.TagSettingsProperties{
									FilterOperator: to.Ptr(armautomation.TagOperatorsAll),
									Tags: map[string][]*string{
										"tag1": {
											to.Ptr("tag1Value1"),
											to.Ptr("tag1Value2"),
											to.Ptr("tag1Value3")},
										"tag2": {
											to.Ptr("tag2Value1"),
											to.Ptr("tag2Value2"),
											to.Ptr("tag2Value3")},
									},
								},
							}},
						NonAzureQueries: []*armautomation.NonAzureQueryProperties{
							{
								FunctionAlias: to.Ptr("SavedSearch1"),
								WorkspaceID:   to.Ptr("WorkspaceId1"),
							},
							{
								FunctionAlias: to.Ptr("SavedSearch2"),
								WorkspaceID:   to.Ptr("WorkspaceId2"),
							}},
					},
					Windows: &armautomation.WindowsProperties{
						ExcludedKbNumbers: []*string{
							to.Ptr("168934"),
							to.Ptr("168973")},
						IncludedUpdateClassifications: to.Ptr(armautomation.WindowsUpdateClassesCritical),
						RebootSetting:                 to.Ptr("IfRequired"),
					},
				},
			},
		},
		&armautomation.SoftwareUpdateConfigurationsClientCreateOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SoftwareUpdateConfigurationsClient) Delete 

func (client *SoftwareUpdateConfigurationsClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationName string, options *SoftwareUpdateConfigurationsClientDeleteOptions) (SoftwareUpdateConfigurationsClientDeleteResponse, error)

Delete - delete a specific software update configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. softwareUpdateConfigurationName - The name of the software update configuration to be created. options - SoftwareUpdateConfigurationsClientDeleteOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"mygroup",
		"myaccount",
		"mypatch",
		&armautomation.SoftwareUpdateConfigurationsClientDeleteOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SoftwareUpdateConfigurationsClient) GetByName 

func (client *SoftwareUpdateConfigurationsClient) GetByName(ctx context.Context, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationName string, options *SoftwareUpdateConfigurationsClientGetByNameOptions) (SoftwareUpdateConfigurationsClientGetByNameResponse, error)

GetByName - Get a single software update configuration by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. softwareUpdateConfigurationName - The name of the software update configuration to be created. options - SoftwareUpdateConfigurationsClientGetByNameOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.GetByName method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetByName(ctx,
		"mygroup",
		"myaccount",
		"mypatch",
		&armautomation.SoftwareUpdateConfigurationsClientGetByNameOptions{ClientRequestID: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SoftwareUpdateConfigurationsClient) List 

func (client *SoftwareUpdateConfigurationsClient) List(ctx context.Context, resourceGroupName string, automationAccountName string, options *SoftwareUpdateConfigurationsClientListOptions) (SoftwareUpdateConfigurationsClientListResponse, error)

List - Get all software update configurations for the account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2019-06-01 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - SoftwareUpdateConfigurationsClientListOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSoftwareUpdateConfigurationsClient("1a7d4044-286c-4acb-969a-96639265bf2e", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"mygroup",
		"myaccount",
		&armautomation.SoftwareUpdateConfigurationsClientListOptions{ClientRequestID: nil,
			Filter: nil,
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type SoftwareUpdateConfigurationsClientCreateOptions added in v0.3.0 

type SoftwareUpdateConfigurationsClientCreateOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

SoftwareUpdateConfigurationsClientCreateOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.Create method.

type SoftwareUpdateConfigurationsClientCreateResponse added in v0.3.0 

type SoftwareUpdateConfigurationsClientCreateResponse struct {
	SoftwareUpdateConfiguration
}

SoftwareUpdateConfigurationsClientCreateResponse contains the response from method SoftwareUpdateConfigurationsClient.Create.

type SoftwareUpdateConfigurationsClientDeleteOptions added in v0.3.0 

type SoftwareUpdateConfigurationsClientDeleteOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

SoftwareUpdateConfigurationsClientDeleteOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.Delete method.

type SoftwareUpdateConfigurationsClientDeleteResponse added in v0.3.0 

type SoftwareUpdateConfigurationsClientDeleteResponse struct {
}

SoftwareUpdateConfigurationsClientDeleteResponse contains the response from method SoftwareUpdateConfigurationsClient.Delete.

type SoftwareUpdateConfigurationsClientGetByNameOptions added in v0.3.0 

type SoftwareUpdateConfigurationsClientGetByNameOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
}

SoftwareUpdateConfigurationsClientGetByNameOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.GetByName method.

type SoftwareUpdateConfigurationsClientGetByNameResponse added in v0.3.0 

type SoftwareUpdateConfigurationsClientGetByNameResponse struct {
	SoftwareUpdateConfiguration
}

SoftwareUpdateConfigurationsClientGetByNameResponse contains the response from method SoftwareUpdateConfigurationsClient.GetByName.

type SoftwareUpdateConfigurationsClientListOptions added in v0.3.0 

type SoftwareUpdateConfigurationsClientListOptions struct {
	// Identifies this specific client request.
	ClientRequestID *string
	// The filter to apply on the operation.
	Filter *string
}

SoftwareUpdateConfigurationsClientListOptions contains the optional parameters for the SoftwareUpdateConfigurationsClient.List method.

type SoftwareUpdateConfigurationsClientListResponse added in v0.3.0 

type SoftwareUpdateConfigurationsClientListResponse struct {
	SoftwareUpdateConfigurationListResult
}

SoftwareUpdateConfigurationsClientListResponse contains the response from method SoftwareUpdateConfigurationsClient.List.

type SourceControl 

type SourceControl struct {
	// The properties of the source control.
	Properties *SourceControlProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SourceControl - Definition of the source control.

type SourceControlClient 

type SourceControlClient struct {
	// contains filtered or unexported fields
}

SourceControlClient contains the methods for the SourceControl group. Don't use this type directly, use NewSourceControlClient() instead.

func NewSourceControlClient 

func NewSourceControlClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SourceControlClient, error)

NewSourceControlClient creates a new instance of SourceControlClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SourceControlClient) CreateOrUpdate 

func (client *SourceControlClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, parameters SourceControlCreateOrUpdateParameters, options *SourceControlClientCreateOrUpdateOptions) (SourceControlClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a source control. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. parameters - The parameters supplied to the create or update source control operation. options - SourceControlClientCreateOrUpdateOptions contains the optional parameters for the SourceControlClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControl/createOrUpdateSourceControl.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"sampleAccount9",
		"sampleSourceControl",
		armautomation.SourceControlCreateOrUpdateParameters{
			Properties: &armautomation.SourceControlCreateOrUpdateProperties{
				Description:    to.Ptr("my description"),
				AutoSync:       to.Ptr(true),
				Branch:         to.Ptr("master"),
				FolderPath:     to.Ptr("/folderOne/folderTwo"),
				PublishRunbook: to.Ptr(true),
				RepoURL:        to.Ptr("https://sampleUser.visualstudio.com/myProject/_git/myRepository"),
				SecurityToken: &armautomation.SourceControlSecurityTokenProperties{
					AccessToken: to.Ptr("3a326f7a0dcd343ea58fee21f2fd5fb4c1234567"),
					TokenType:   to.Ptr(armautomation.TokenTypePersonalAccessToken),
				},
				SourceType: to.Ptr(armautomation.SourceTypeVsoGit),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SourceControlClient) Delete 

func (client *SourceControlClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, options *SourceControlClientDeleteOptions) (SourceControlClientDeleteResponse, error)

Delete - Delete the source control. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The name of source control. options - SourceControlClientDeleteOptions contains the optional parameters for the SourceControlClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControl/deleteSourceControl.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"sampleAccount9",
		"sampleSourceControl",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SourceControlClient) Get 

func (client *SourceControlClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, options *SourceControlClientGetOptions) (SourceControlClientGetResponse, error)

Get - Retrieve the source control identified by source control name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The name of source control. options - SourceControlClientGetOptions contains the optional parameters for the SourceControlClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControl/getSourceControl.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"sampleAccount9",
		"sampleSourceControl",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SourceControlClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *SourceControlClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *SourceControlClientListByAutomationAccountOptions) *runtime.Pager[SourceControlClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of source controls. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - SourceControlClientListByAutomationAccountOptions contains the optional parameters for the SourceControlClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControl/getAllSourceControls.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"sampleAccount9",
		&armautomation.SourceControlClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*SourceControlClient) Update 

func (client *SourceControlClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, parameters SourceControlUpdateParameters, options *SourceControlClientUpdateOptions) (SourceControlClientUpdateResponse, error)

Update - Update a source control. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. parameters - The parameters supplied to the update source control operation. options - SourceControlClientUpdateOptions contains the optional parameters for the SourceControlClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControl/updateSourceControl_patch.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"sampleAccount9",
		"sampleSourceControl",
		armautomation.SourceControlUpdateParameters{
			Properties: &armautomation.SourceControlUpdateProperties{
				Description:    to.Ptr("my description"),
				AutoSync:       to.Ptr(true),
				Branch:         to.Ptr("master"),
				FolderPath:     to.Ptr("/folderOne/folderTwo"),
				PublishRunbook: to.Ptr(true),
				SecurityToken: &armautomation.SourceControlSecurityTokenProperties{
					AccessToken: to.Ptr("3a326f7a0dcd343ea58fee21f2fd5fb4c1234567"),
					TokenType:   to.Ptr(armautomation.TokenTypePersonalAccessToken),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type SourceControlClientCreateOrUpdateOptions added in v0.3.0 

type SourceControlClientCreateOrUpdateOptions struct {
}

SourceControlClientCreateOrUpdateOptions contains the optional parameters for the SourceControlClient.CreateOrUpdate method.

type SourceControlClientCreateOrUpdateResponse added in v0.3.0 

type SourceControlClientCreateOrUpdateResponse struct {
	SourceControl
}

SourceControlClientCreateOrUpdateResponse contains the response from method SourceControlClient.CreateOrUpdate.

type SourceControlClientDeleteOptions added in v0.3.0 

type SourceControlClientDeleteOptions struct {
}

SourceControlClientDeleteOptions contains the optional parameters for the SourceControlClient.Delete method.

type SourceControlClientDeleteResponse added in v0.3.0 

type SourceControlClientDeleteResponse struct {
}

SourceControlClientDeleteResponse contains the response from method SourceControlClient.Delete.

type SourceControlClientGetOptions added in v0.3.0 

type SourceControlClientGetOptions struct {
}

SourceControlClientGetOptions contains the optional parameters for the SourceControlClient.Get method.

type SourceControlClientGetResponse added in v0.3.0 

type SourceControlClientGetResponse struct {
	SourceControl
}

SourceControlClientGetResponse contains the response from method SourceControlClient.Get.

type SourceControlClientListByAutomationAccountOptions added in v0.3.0 

type SourceControlClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

SourceControlClientListByAutomationAccountOptions contains the optional parameters for the SourceControlClient.ListByAutomationAccount method.

type SourceControlClientListByAutomationAccountResponse added in v0.3.0 

type SourceControlClientListByAutomationAccountResponse struct {
	SourceControlListResult
}

SourceControlClientListByAutomationAccountResponse contains the response from method SourceControlClient.ListByAutomationAccount.

type SourceControlClientUpdateOptions added in v0.3.0 

type SourceControlClientUpdateOptions struct {
}

SourceControlClientUpdateOptions contains the optional parameters for the SourceControlClient.Update method.

type SourceControlClientUpdateResponse added in v0.3.0 

type SourceControlClientUpdateResponse struct {
	SourceControl
}

SourceControlClientUpdateResponse contains the response from method SourceControlClient.Update.

type SourceControlCreateOrUpdateParameters 

type SourceControlCreateOrUpdateParameters struct {
	// REQUIRED; The properties of the source control.
	Properties *SourceControlCreateOrUpdateProperties `json:"properties,omitempty"`
}

SourceControlCreateOrUpdateParameters - The parameters supplied to the create or update source control operation.

type SourceControlCreateOrUpdateProperties 

type SourceControlCreateOrUpdateProperties struct {
	// The auto async of the source control. Default is false.
	AutoSync *bool `json:"autoSync,omitempty"`

	// The repo branch of the source control. Include branch as empty string for VsoTfvc.
	Branch *string `json:"branch,omitempty"`

	// The user description of the source control.
	Description *string `json:"description,omitempty"`

	// The folder path of the source control. Path must be relative.
	FolderPath *string `json:"folderPath,omitempty"`

	// The auto publish of the source control. Default is true.
	PublishRunbook *bool `json:"publishRunbook,omitempty"`

	// The repo url of the source control.
	RepoURL *string `json:"repoUrl,omitempty"`

	// The authorization token for the repo of the source control.
	SecurityToken *SourceControlSecurityTokenProperties `json:"securityToken,omitempty"`

	// The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.
	SourceType *SourceType `json:"sourceType,omitempty"`
}

SourceControlCreateOrUpdateProperties - The properties of the create source control operation.

type SourceControlListResult 

type SourceControlListResult struct {
	// The next link.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of source controls.
	Value []*SourceControl `json:"value,omitempty"`
}

SourceControlListResult - The response model for the list source controls operation.

type SourceControlProperties 

type SourceControlProperties struct {
	// The auto sync of the source control. Default is false.
	AutoSync *bool `json:"autoSync,omitempty"`

	// The repo branch of the source control. Include branch as empty string for VsoTfvc.
	Branch *string `json:"branch,omitempty"`

	// The creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// The description.
	Description *string `json:"description,omitempty"`

	// The folder path of the source control.
	FolderPath *string `json:"folderPath,omitempty"`

	// The last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// The auto publish of the source control. Default is true.
	PublishRunbook *bool `json:"publishRunbook,omitempty"`

	// The repo url of the source control.
	RepoURL *string `json:"repoUrl,omitempty"`

	// The source type. Must be one of VsoGit, VsoTfvc, GitHub.
	SourceType *SourceType `json:"sourceType,omitempty"`
}

SourceControlProperties - Definition of the source control properties

func (SourceControlProperties) MarshalJSON 

func (s SourceControlProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlProperties.

func (*SourceControlProperties) UnmarshalJSON 

func (s *SourceControlProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlProperties.

type SourceControlSecurityTokenProperties 

type SourceControlSecurityTokenProperties struct {
	// The access token.
	AccessToken *string `json:"accessToken,omitempty"`

	// The refresh token.
	RefreshToken *string `json:"refreshToken,omitempty"`

	// The token type. Must be either PersonalAccessToken or Oauth.
	TokenType *TokenType `json:"tokenType,omitempty"`
}

type SourceControlSyncJob 

type SourceControlSyncJob struct {
	// The properties of the source control sync job.
	Properties *SourceControlSyncJobProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SourceControlSyncJob - Definition of the source control sync job.

type SourceControlSyncJobByID 

type SourceControlSyncJobByID struct {
	// The id of the job.
	ID *string `json:"id,omitempty"`

	// The properties of the source control sync job.
	Properties *SourceControlSyncJobByIDProperties `json:"properties,omitempty"`
}

SourceControlSyncJobByID - Definition of the source control sync job.

type SourceControlSyncJobByIDProperties 

type SourceControlSyncJobByIDProperties struct {
	// The exceptions that occurred while running the sync job.
	Exception *string `json:"exception,omitempty"`

	// The provisioning state of the job.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`

	// The source control sync job id.
	SourceControlSyncJobID *string `json:"sourceControlSyncJobId,omitempty"`

	// The sync type.
	SyncType *SyncType `json:"syncType,omitempty"`

	// READ-ONLY; The creation time of the job.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; The end time of the job.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; The start time of the job.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`
}

SourceControlSyncJobByIDProperties - Definition of source control sync job properties.

func (*SourceControlSyncJobByIDProperties) UnmarshalJSON 

func (s *SourceControlSyncJobByIDProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlSyncJobByIDProperties.

type SourceControlSyncJobClient 

type SourceControlSyncJobClient struct {
	// contains filtered or unexported fields
}

SourceControlSyncJobClient contains the methods for the SourceControlSyncJob group. Don't use this type directly, use NewSourceControlSyncJobClient() instead.

func NewSourceControlSyncJobClient 

func NewSourceControlSyncJobClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SourceControlSyncJobClient, error)

NewSourceControlSyncJobClient creates a new instance of SourceControlSyncJobClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SourceControlSyncJobClient) Create 

func (client *SourceControlSyncJobClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, sourceControlSyncJobID string, parameters SourceControlSyncJobCreateParameters, options *SourceControlSyncJobClientCreateOptions) (SourceControlSyncJobClientCreateResponse, error)

Create - Creates the sync job for a source control. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. sourceControlSyncJobID - The source control sync job id. parameters - The parameters supplied to the create source control sync job operation. options - SourceControlSyncJobClientCreateOptions contains the optional parameters for the SourceControlSyncJobClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControlSyncJob/createSourceControlSyncJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlSyncJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Create(ctx,
		"rg",
		"myAutomationAccount33",
		"MySourceControl",
		"ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a",
		armautomation.SourceControlSyncJobCreateParameters{
			Properties: &armautomation.SourceControlSyncJobCreateProperties{
				CommitID: to.Ptr("9de0980bfb45026a3d97a1b0522d98a9f604226e"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SourceControlSyncJobClient) Get 

func (client *SourceControlSyncJobClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, sourceControlSyncJobID string, options *SourceControlSyncJobClientGetOptions) (SourceControlSyncJobClientGetResponse, error)

Get - Retrieve the source control sync job identified by job id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. sourceControlSyncJobID - The source control sync job id. options - SourceControlSyncJobClientGetOptions contains the optional parameters for the SourceControlSyncJobClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlSyncJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"MySourceControl",
		"ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SourceControlSyncJobClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *SourceControlSyncJobClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, sourceControlName string, options *SourceControlSyncJobClientListByAutomationAccountOptions) *runtime.Pager[SourceControlSyncJobClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of source control sync jobs. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. options - SourceControlSyncJobClientListByAutomationAccountOptions contains the optional parameters for the SourceControlSyncJobClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlSyncJobClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		"MySourceControl",
		&armautomation.SourceControlSyncJobClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type SourceControlSyncJobClientCreateOptions added in v0.3.0 

type SourceControlSyncJobClientCreateOptions struct {
}

SourceControlSyncJobClientCreateOptions contains the optional parameters for the SourceControlSyncJobClient.Create method.

type SourceControlSyncJobClientCreateResponse added in v0.3.0 

type SourceControlSyncJobClientCreateResponse struct {
	SourceControlSyncJob
}

SourceControlSyncJobClientCreateResponse contains the response from method SourceControlSyncJobClient.Create.

type SourceControlSyncJobClientGetOptions added in v0.3.0 

type SourceControlSyncJobClientGetOptions struct {
}

SourceControlSyncJobClientGetOptions contains the optional parameters for the SourceControlSyncJobClient.Get method.

type SourceControlSyncJobClientGetResponse added in v0.3.0 

type SourceControlSyncJobClientGetResponse struct {
	SourceControlSyncJobByID
}

SourceControlSyncJobClientGetResponse contains the response from method SourceControlSyncJobClient.Get.

type SourceControlSyncJobClientListByAutomationAccountOptions added in v0.3.0 

type SourceControlSyncJobClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

SourceControlSyncJobClientListByAutomationAccountOptions contains the optional parameters for the SourceControlSyncJobClient.ListByAutomationAccount method.

type SourceControlSyncJobClientListByAutomationAccountResponse added in v0.3.0 

type SourceControlSyncJobClientListByAutomationAccountResponse struct {
	SourceControlSyncJobListResult
}

SourceControlSyncJobClientListByAutomationAccountResponse contains the response from method SourceControlSyncJobClient.ListByAutomationAccount.

type SourceControlSyncJobCreateParameters 

type SourceControlSyncJobCreateParameters struct {
	// REQUIRED; The properties of the source control sync job.
	Properties *SourceControlSyncJobCreateProperties `json:"properties,omitempty"`
}

SourceControlSyncJobCreateParameters - The parameters supplied to the create source control sync job operation.

type SourceControlSyncJobCreateProperties 

type SourceControlSyncJobCreateProperties struct {
	// REQUIRED; The commit id of the source control sync job. If not syncing to a commitId, enter an empty string.
	CommitID *string `json:"commitId,omitempty"`
}

SourceControlSyncJobCreateProperties - Definition of create source control sync job properties.

type SourceControlSyncJobListResult 

type SourceControlSyncJobListResult struct {
	// The next link.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of source control sync jobs.
	Value []*SourceControlSyncJob `json:"value,omitempty"`
}

SourceControlSyncJobListResult - The response model for the list source control sync jobs operation.

type SourceControlSyncJobProperties 

type SourceControlSyncJobProperties struct {
	// The provisioning state of the job.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`

	// The source control sync job id.
	SourceControlSyncJobID *string `json:"sourceControlSyncJobId,omitempty"`

	// The sync type.
	SyncType *SyncType `json:"syncType,omitempty"`

	// READ-ONLY; The creation time of the job.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; The end time of the job.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; The start time of the job.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`
}

SourceControlSyncJobProperties - Definition of source control sync job properties.

func (*SourceControlSyncJobProperties) UnmarshalJSON 

func (s *SourceControlSyncJobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlSyncJobProperties.

type SourceControlSyncJobStream 

type SourceControlSyncJobStream struct {
	// The properties of the source control sync job stream.
	Properties *SourceControlSyncJobStreamProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource id.
	ID *string `json:"id,omitempty" azure:"ro"`
}

SourceControlSyncJobStream - Definition of the source control sync job stream.

type SourceControlSyncJobStreamByID 

type SourceControlSyncJobStreamByID struct {
	// The properties of the source control sync job stream.
	Properties *SourceControlSyncJobStreamByIDProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource id.
	ID *string `json:"id,omitempty" azure:"ro"`
}

SourceControlSyncJobStreamByID - Definition of the source control sync job stream by id.

type SourceControlSyncJobStreamByIDProperties 

type SourceControlSyncJobStreamByIDProperties struct {
	// The sync job stream id.
	SourceControlSyncJobStreamID *string `json:"sourceControlSyncJobStreamId,omitempty"`

	// The text of the sync job stream.
	StreamText *string `json:"streamText,omitempty"`

	// The type of the sync job stream.
	StreamType *StreamType `json:"streamType,omitempty"`

	// The summary of the sync job stream.
	Summary *string `json:"summary,omitempty"`

	// The values of the job stream.
	Value map[string]interface{} `json:"value,omitempty"`

	// READ-ONLY; The time of the sync job stream.
	Time *time.Time `json:"time,omitempty" azure:"ro"`
}

SourceControlSyncJobStreamByIDProperties - Definition of source control sync job stream by id properties.

func (*SourceControlSyncJobStreamByIDProperties) UnmarshalJSON 

func (s *SourceControlSyncJobStreamByIDProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlSyncJobStreamByIDProperties.

type SourceControlSyncJobStreamProperties 

type SourceControlSyncJobStreamProperties struct {
	// The sync job stream id.
	SourceControlSyncJobStreamID *string `json:"sourceControlSyncJobStreamId,omitempty"`

	// The type of the sync job stream.
	StreamType *StreamType `json:"streamType,omitempty"`

	// The summary of the sync job stream.
	Summary *string `json:"summary,omitempty"`

	// READ-ONLY; The time of the sync job stream.
	Time *time.Time `json:"time,omitempty" azure:"ro"`
}

SourceControlSyncJobStreamProperties - Definition of source control sync job stream properties.

func (*SourceControlSyncJobStreamProperties) UnmarshalJSON 

func (s *SourceControlSyncJobStreamProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceControlSyncJobStreamProperties.

type SourceControlSyncJobStreamsClient 

type SourceControlSyncJobStreamsClient struct {
	// contains filtered or unexported fields
}

SourceControlSyncJobStreamsClient contains the methods for the SourceControlSyncJobStreams group. Don't use this type directly, use NewSourceControlSyncJobStreamsClient() instead.

func NewSourceControlSyncJobStreamsClient 

func NewSourceControlSyncJobStreamsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SourceControlSyncJobStreamsClient, error)

NewSourceControlSyncJobStreamsClient creates a new instance of SourceControlSyncJobStreamsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SourceControlSyncJobStreamsClient) Get 

func (client *SourceControlSyncJobStreamsClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, sourceControlName string, sourceControlSyncJobID string, streamID string, options *SourceControlSyncJobStreamsClientGetOptions) (SourceControlSyncJobStreamsClientGetResponse, error)

Get - Retrieve a sync job stream identified by stream id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. sourceControlSyncJobID - The source control sync job id. streamID - The id of the sync job stream. options - SourceControlSyncJobStreamsClientGetOptions contains the optional parameters for the SourceControlSyncJobStreamsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreamsByStreamId.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlSyncJobStreamsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"MySourceControl",
		"ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b",
		"b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855139029522_00000000000000000007",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*SourceControlSyncJobStreamsClient) NewListBySyncJobPager added in v0.5.0 

func (client *SourceControlSyncJobStreamsClient) NewListBySyncJobPager(resourceGroupName string, automationAccountName string, sourceControlName string, sourceControlSyncJobID string, options *SourceControlSyncJobStreamsClientListBySyncJobOptions) *runtime.Pager[SourceControlSyncJobStreamsClientListBySyncJobResponse]

NewListBySyncJobPager - Retrieve a list of sync job streams identified by sync job id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. sourceControlName - The source control name. sourceControlSyncJobID - The source control sync job id. options - SourceControlSyncJobStreamsClientListBySyncJobOptions contains the optional parameters for the SourceControlSyncJobStreamsClient.ListBySyncJob method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreams.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewSourceControlSyncJobStreamsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySyncJobPager("rg",
		"myAutomationAccount33",
		"MySourceControl",
		"ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b",
		&armautomation.SourceControlSyncJobStreamsClientListBySyncJobOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type SourceControlSyncJobStreamsClientGetOptions added in v0.3.0 

type SourceControlSyncJobStreamsClientGetOptions struct {
}

SourceControlSyncJobStreamsClientGetOptions contains the optional parameters for the SourceControlSyncJobStreamsClient.Get method.

type SourceControlSyncJobStreamsClientGetResponse added in v0.3.0 

type SourceControlSyncJobStreamsClientGetResponse struct {
	SourceControlSyncJobStreamByID
}

SourceControlSyncJobStreamsClientGetResponse contains the response from method SourceControlSyncJobStreamsClient.Get.

type SourceControlSyncJobStreamsClientListBySyncJobOptions added in v0.3.0 

type SourceControlSyncJobStreamsClientListBySyncJobOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

SourceControlSyncJobStreamsClientListBySyncJobOptions contains the optional parameters for the SourceControlSyncJobStreamsClient.ListBySyncJob method.

type SourceControlSyncJobStreamsClientListBySyncJobResponse added in v0.3.0 

type SourceControlSyncJobStreamsClientListBySyncJobResponse struct {
	SourceControlSyncJobStreamsListBySyncJob
}

SourceControlSyncJobStreamsClientListBySyncJobResponse contains the response from method SourceControlSyncJobStreamsClient.ListBySyncJob.

type SourceControlSyncJobStreamsListBySyncJob 

type SourceControlSyncJobStreamsListBySyncJob struct {
	// The list of source control sync job streams.
	Value []*SourceControlSyncJobStream `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SourceControlSyncJobStreamsListBySyncJob - The response model for the list source control sync job streams operation.

type SourceControlUpdateParameters 

type SourceControlUpdateParameters struct {
	// The value of the source control.
	Properties *SourceControlUpdateProperties `json:"properties,omitempty"`
}

SourceControlUpdateParameters - The parameters supplied to the update source control operation.

func (SourceControlUpdateParameters) MarshalJSON 

func (s SourceControlUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlUpdateParameters.

type SourceControlUpdateProperties 

type SourceControlUpdateProperties struct {
	// The auto sync of the source control. Default is false.
	AutoSync *bool `json:"autoSync,omitempty"`

	// The repo branch of the source control.
	Branch *string `json:"branch,omitempty"`

	// The user description of the source control.
	Description *string `json:"description,omitempty"`

	// The folder path of the source control. Path must be relative.
	FolderPath *string `json:"folderPath,omitempty"`

	// The auto publish of the source control. Default is true.
	PublishRunbook *bool `json:"publishRunbook,omitempty"`

	// The authorization token for the repo of the source control.
	SecurityToken *SourceControlSecurityTokenProperties `json:"securityToken,omitempty"`
}

SourceControlUpdateProperties - The properties of the update source control

type SourceType 

type SourceType string

SourceType - The source type. Must be one of VsoGit, VsoTfvc, GitHub. 

const (
	SourceTypeGitHub  SourceType = "GitHub"
	SourceTypeVsoGit  SourceType = "VsoGit"
	SourceTypeVsoTfvc SourceType = "VsoTfvc"
)

func PossibleSourceTypeValues 

func PossibleSourceTypeValues() []SourceType

PossibleSourceTypeValues returns the possible values for the SourceType const type.

type Statistics 

type Statistics struct {
	// READ-ONLY; Gets the property value of the statistic.
	CounterProperty *string `json:"counterProperty,omitempty" azure:"ro"`

	// READ-ONLY; Gets the value of the statistic.
	CounterValue *int64 `json:"counterValue,omitempty" azure:"ro"`

	// READ-ONLY; Gets the endTime of the statistic.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Gets the startTime of the statistic.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`
}

Statistics - Definition of the statistic.

func (*Statistics) UnmarshalJSON 

func (s *Statistics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Statistics.

type StatisticsClient 

type StatisticsClient struct {
	// contains filtered or unexported fields
}

StatisticsClient contains the methods for the Statistics group. Don't use this type directly, use NewStatisticsClient() instead.

func NewStatisticsClient 

func NewStatisticsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StatisticsClient, error)

NewStatisticsClient creates a new instance of StatisticsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*StatisticsClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *StatisticsClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *StatisticsClientListByAutomationAccountOptions) *runtime.Pager[StatisticsClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve the statistics for the account. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - StatisticsClientListByAutomationAccountOptions contains the optional parameters for the StatisticsClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getStatisticsOfAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewStatisticsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount11",
		&armautomation.StatisticsClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type StatisticsClientListByAutomationAccountOptions added in v0.3.0 

type StatisticsClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

StatisticsClientListByAutomationAccountOptions contains the optional parameters for the StatisticsClient.ListByAutomationAccount method.

type StatisticsClientListByAutomationAccountResponse added in v0.3.0 

type StatisticsClientListByAutomationAccountResponse struct {
	StatisticsListResult
}

StatisticsClientListByAutomationAccountResponse contains the response from method StatisticsClient.ListByAutomationAccount.

type StatisticsListResult 

type StatisticsListResult struct {
	// Gets or sets a list of statistics.
	Value []*Statistics `json:"value,omitempty"`
}

StatisticsListResult - The response model for the list statistics operation.

type StreamType 

type StreamType string

StreamType - The type of the sync job stream. 

const (
	StreamTypeError  StreamType = "Error"
	StreamTypeOutput StreamType = "Output"
)

func PossibleStreamTypeValues 

func PossibleStreamTypeValues() []StreamType

PossibleStreamTypeValues returns the possible values for the StreamType const type.

type SyncType 

type SyncType string

SyncType - The sync type. 

const (
	SyncTypeFullSync    SyncType = "FullSync"
	SyncTypePartialSync SyncType = "PartialSync"
)

func PossibleSyncTypeValues 

func PossibleSyncTypeValues() []SyncType

PossibleSyncTypeValues returns the possible values for the SyncType const type.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TagOperators 

type TagOperators string

TagOperators - Filter VMs by Any or All specified tags. 

const (
	TagOperatorsAll TagOperators = "All"
	TagOperatorsAny TagOperators = "Any"
)

func PossibleTagOperatorsValues 

func PossibleTagOperatorsValues() []TagOperators

PossibleTagOperatorsValues returns the possible values for the TagOperators const type.

type TagSettingsProperties 

type TagSettingsProperties struct {
	// Filter VMs by Any or All specified tags.
	FilterOperator *TagOperators `json:"filterOperator,omitempty"`

	// Dictionary of tags with its list of values.
	Tags map[string][]*string `json:"tags,omitempty"`
}

TagSettingsProperties - Tag filter information for the VM.

func (TagSettingsProperties) MarshalJSON 

func (t TagSettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagSettingsProperties.

type TargetProperties 

type TargetProperties struct {
	// List of Azure queries in the software update configuration.
	AzureQueries []*AzureQueryProperties `json:"azureQueries,omitempty"`

	// List of non Azure queries in the software update configuration.
	NonAzureQueries []*NonAzureQueryProperties `json:"nonAzureQueries,omitempty"`
}

TargetProperties - Group specific to the update configuration.

func (TargetProperties) MarshalJSON 

func (t TargetProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetProperties.

type TaskProperties 

type TaskProperties struct {
	// Gets or sets the parameters of the task.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the name of the runbook.
	Source *string `json:"source,omitempty"`
}

TaskProperties - Task properties of the software update configuration.

func (TaskProperties) MarshalJSON 

func (t TaskProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TaskProperties.

type TestJob 

type TestJob struct {
	// Gets or sets the creation time of the test job.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the end time of the test job.
	EndTime *time.Time `json:"endTime,omitempty"`

	// Gets or sets the exception of the test job.
	Exception *string `json:"exception,omitempty"`

	// Gets or sets the last modified time of the test job.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the last status modified time of the test job.
	LastStatusModifiedTime *time.Time `json:"lastStatusModifiedTime,omitempty"`

	// The activity-level tracing options of the runbook.
	LogActivityTrace *int32 `json:"logActivityTrace,omitempty"`

	// Gets or sets the parameters of the test job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the runOn which specifies the group name where the job is to be executed.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the start time of the test job.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Gets or sets the status of the test job.
	Status *string `json:"status,omitempty"`

	// Gets or sets the status details of the test job.
	StatusDetails *string `json:"statusDetails,omitempty"`
}

TestJob - Definition of the test job.

func (*TestJob) UnmarshalJSON 

func (t *TestJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TestJob.

type TestJobClient 

type TestJobClient struct {
	// contains filtered or unexported fields
}

TestJobClient contains the methods for the TestJob group. Don't use this type directly, use NewTestJobClient() instead.

func NewTestJobClient 

func NewTestJobClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TestJobClient, error)

NewTestJobClient creates a new instance of TestJobClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*TestJobClient) Create 

func (client *TestJobClient) Create(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, parameters TestJobCreateParameters, options *TestJobClientCreateOptions) (TestJobClientCreateResponse, error)

Create - Create a test job of the runbook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The parameters supplied to the create test job operation. parameters - The parameters supplied to the create test job operation. options - TestJobClientCreateOptions contains the optional parameters for the TestJobClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/createTestJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Create(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		armautomation.TestJobCreateParameters{
			Parameters: map[string]*string{
				"key01": to.Ptr("value01"),
				"key02": to.Ptr("value02"),
			},
			RunOn: to.Ptr(""),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*TestJobClient) Get 

func (client *TestJobClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *TestJobClientGetOptions) (TestJobClientGetResponse, error)

Get - Retrieve the test job for the specified runbook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - TestJobClientGetOptions contains the optional parameters for the TestJobClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getTestJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TestJobClient) Resume 

func (client *TestJobClient) Resume(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *TestJobClientResumeOptions) (TestJobClientResumeResponse, error)

Resume - Resume the test job. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - TestJobClientResumeOptions contains the optional parameters for the TestJobClient.Resume method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/resumeTestJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Resume(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*TestJobClient) Stop 

func (client *TestJobClient) Stop(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *TestJobClientStopOptions) (TestJobClientStopResponse, error)

Stop - Stop the test job. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - TestJobClientStopOptions contains the optional parameters for the TestJobClient.Stop method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/stopTestJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Stop(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*TestJobClient) Suspend 

func (client *TestJobClient) Suspend(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, options *TestJobClientSuspendOptions) (TestJobClientSuspendResponse, error)

Suspend - Suspend the test job. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - TestJobClientSuspendOptions contains the optional parameters for the TestJobClient.Suspend method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/suspendTestJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Suspend(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type TestJobClientCreateOptions added in v0.3.0 

type TestJobClientCreateOptions struct {
}

TestJobClientCreateOptions contains the optional parameters for the TestJobClient.Create method.

type TestJobClientCreateResponse added in v0.3.0 

type TestJobClientCreateResponse struct {
	TestJob
}

TestJobClientCreateResponse contains the response from method TestJobClient.Create.

type TestJobClientGetOptions added in v0.3.0 

type TestJobClientGetOptions struct {
}

TestJobClientGetOptions contains the optional parameters for the TestJobClient.Get method.

type TestJobClientGetResponse added in v0.3.0 

type TestJobClientGetResponse struct {
	TestJob
}

TestJobClientGetResponse contains the response from method TestJobClient.Get.

type TestJobClientResumeOptions added in v0.3.0 

type TestJobClientResumeOptions struct {
}

TestJobClientResumeOptions contains the optional parameters for the TestJobClient.Resume method.

type TestJobClientResumeResponse added in v0.3.0 

type TestJobClientResumeResponse struct {
}

TestJobClientResumeResponse contains the response from method TestJobClient.Resume.

type TestJobClientStopOptions added in v0.3.0 

type TestJobClientStopOptions struct {
}

TestJobClientStopOptions contains the optional parameters for the TestJobClient.Stop method.

type TestJobClientStopResponse added in v0.3.0 

type TestJobClientStopResponse struct {
}

TestJobClientStopResponse contains the response from method TestJobClient.Stop.

type TestJobClientSuspendOptions added in v0.3.0 

type TestJobClientSuspendOptions struct {
}

TestJobClientSuspendOptions contains the optional parameters for the TestJobClient.Suspend method.

type TestJobClientSuspendResponse added in v0.3.0 

type TestJobClientSuspendResponse struct {
}

TestJobClientSuspendResponse contains the response from method TestJobClient.Suspend.

type TestJobCreateParameters 

type TestJobCreateParameters struct {
	// Gets or sets the parameters of the test job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the runOn which specifies the group name where the job is to be executed.
	RunOn *string `json:"runOn,omitempty"`
}

TestJobCreateParameters - The parameters supplied to the create test job operation.

func (TestJobCreateParameters) MarshalJSON 

func (t TestJobCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TestJobCreateParameters.

type TestJobStreamsClient 

type TestJobStreamsClient struct {
	// contains filtered or unexported fields
}

TestJobStreamsClient contains the methods for the TestJobStreams group. Don't use this type directly, use NewTestJobStreamsClient() instead.

func NewTestJobStreamsClient 

func NewTestJobStreamsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TestJobStreamsClient, error)

NewTestJobStreamsClient creates a new instance of TestJobStreamsClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*TestJobStreamsClient) Get 

func (client *TestJobStreamsClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, runbookName string, jobStreamID string, options *TestJobStreamsClientGetOptions) (TestJobStreamsClientGetResponse, error)

Get - Retrieve a test job stream of the test job identified by runbook name and stream id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. jobStreamID - The job stream id. options - TestJobStreamsClientGetOptions contains the optional parameters for the TestJobStreamsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/getTestJobStream.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobStreamsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		"851b2101-686f-40e2-8a4b-5b8df08afbd1_00636535684910693884_00000000000000000001",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TestJobStreamsClient) NewListByTestJobPager added in v0.5.0 

func (client *TestJobStreamsClient) NewListByTestJobPager(resourceGroupName string, automationAccountName string, runbookName string, options *TestJobStreamsClientListByTestJobOptions) *runtime.Pager[TestJobStreamsClientListByTestJobResponse]

NewListByTestJobPager - Retrieve a list of test job streams identified by runbook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-30 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. runbookName - The runbook name. options - TestJobStreamsClientListByTestJobOptions contains the optional parameters for the TestJobStreamsClient.ListByTestJob method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/examples/listTestJobStreamsByJob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewTestJobStreamsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByTestJobPager("mygroup",
		"ContoseAutomationAccount",
		"Get-AzureVMTutorial",
		&armautomation.TestJobStreamsClientListByTestJobOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type TestJobStreamsClientGetOptions added in v0.3.0 

type TestJobStreamsClientGetOptions struct {
}

TestJobStreamsClientGetOptions contains the optional parameters for the TestJobStreamsClient.Get method.

type TestJobStreamsClientGetResponse added in v0.3.0 

type TestJobStreamsClientGetResponse struct {
	JobStream
}

TestJobStreamsClientGetResponse contains the response from method TestJobStreamsClient.Get.

type TestJobStreamsClientListByTestJobOptions added in v0.3.0 

type TestJobStreamsClientListByTestJobOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

TestJobStreamsClientListByTestJobOptions contains the optional parameters for the TestJobStreamsClient.ListByTestJob method.

type TestJobStreamsClientListByTestJobResponse added in v0.3.0 

type TestJobStreamsClientListByTestJobResponse struct {
	JobStreamListResult
}

TestJobStreamsClientListByTestJobResponse contains the response from method TestJobStreamsClient.ListByTestJob.

type TokenType 

type TokenType string

TokenType - The token type. Must be either PersonalAccessToken or Oauth. 

const (
	TokenTypeOauth               TokenType = "Oauth"
	TokenTypePersonalAccessToken TokenType = "PersonalAccessToken"
)

func PossibleTokenTypeValues 

func PossibleTokenTypeValues() []TokenType

PossibleTokenTypeValues returns the possible values for the TokenType const type.

type TrackedResource 

type TrackedResource struct {
	// The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type TypeField 

type TypeField struct {
	// Gets or sets the name of the field.
	Name *string `json:"name,omitempty"`

	// Gets or sets the type of the field.
	Type *string `json:"type,omitempty"`
}

TypeField - Information about a field of a type.

type TypeFieldListResult 

type TypeFieldListResult struct {
	// Gets or sets a list of fields.
	Value []*TypeField `json:"value,omitempty"`
}

TypeFieldListResult - The response model for the list fields operation.

type UpdateConfiguration 

type UpdateConfiguration struct {
	// REQUIRED; operating system of target machines
	OperatingSystem *OperatingSystemType `json:"operatingSystem,omitempty"`

	// List of azure resource Ids for azure virtual machines targeted by the software update configuration.
	AzureVirtualMachines []*string `json:"azureVirtualMachines,omitempty"`

	// Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S
	// as per ISO8601
	Duration *string `json:"duration,omitempty"`

	// Linux specific update configuration.
	Linux *LinuxProperties `json:"linux,omitempty"`

	// List of names of non-azure machines targeted by the software update configuration.
	NonAzureComputerNames []*string `json:"nonAzureComputerNames,omitempty"`

	// Group targets for the software update configuration.
	Targets *TargetProperties `json:"targets,omitempty"`

	// Windows specific update configuration.
	Windows *WindowsProperties `json:"windows,omitempty"`
}

UpdateConfiguration - Update specific properties of the software update configuration.

func (UpdateConfiguration) MarshalJSON 

func (u UpdateConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateConfiguration.

type UpdateConfigurationMachineRunProperties 

type UpdateConfigurationMachineRunProperties struct {
	// Details of provisioning error
	Error *ErrorResponse `json:"error,omitempty"`

	// Job associated with the software update configuration machine run
	Job *JobNavigation `json:"job,omitempty"`

	// software update configuration triggered this run
	SoftwareUpdateConfiguration *UpdateConfigurationNavigation `json:"softwareUpdateConfiguration,omitempty"`

	// READ-ONLY; configured duration for the software update configuration run.
	ConfiguredDuration *string `json:"configuredDuration,omitempty" azure:"ro"`

	// READ-ONLY; correlation id of the software update configuration machine run
	CorrelationID *string `json:"correlationId,omitempty" azure:"ro"`

	// READ-ONLY; createdBy property, which only appears in the response.
	CreatedBy *string `json:"createdBy,omitempty" azure:"ro"`

	// READ-ONLY; Creation time of the resource, which only appears in the response.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; End time of the software update configuration machine run.
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; lastModifiedBy property, which only appears in the response.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; Last time resource was modified, which only appears in the response.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Operating system target of the software update configuration triggered this run
	OSType *string `json:"osType,omitempty" azure:"ro"`

	// READ-ONLY; source computer id of the software update configuration machine run
	SourceComputerID *string `json:"sourceComputerId,omitempty" azure:"ro"`

	// READ-ONLY; Start time of the software update configuration machine run.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; Status of the software update configuration machine run.
	Status *string `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; name of the updated computer
	TargetComputer *string `json:"targetComputer,omitempty" azure:"ro"`

	// READ-ONLY; type of the updated computer.
	TargetComputerType *string `json:"targetComputerType,omitempty" azure:"ro"`
}

UpdateConfigurationMachineRunProperties - Software update configuration machine run properties.

func (*UpdateConfigurationMachineRunProperties) UnmarshalJSON 

func (u *UpdateConfigurationMachineRunProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateConfigurationMachineRunProperties.

type UpdateConfigurationNavigation 

type UpdateConfigurationNavigation struct {
	// READ-ONLY; Name of the software update configuration triggered the software update configuration run
	Name *string `json:"name,omitempty" azure:"ro"`
}

UpdateConfigurationNavigation - Software update configuration Run Navigation model.

type Usage 

type Usage struct {
	// Gets or sets the current usage value.
	CurrentValue *float64 `json:"currentValue,omitempty"`

	// Gets or sets the id of the resource.
	ID *string `json:"id,omitempty"`

	// Gets or sets max limit. -1 for unlimited
	Limit *int64 `json:"limit,omitempty"`

	// Gets or sets the usage counter name.
	Name *UsageCounterName `json:"name,omitempty"`

	// Gets or sets the throttle status.
	ThrottleStatus *string `json:"throttleStatus,omitempty"`

	// Gets or sets the usage unit name.
	Unit *string `json:"unit,omitempty"`
}

Usage - Definition of Usage.

type UsageCounterName 

type UsageCounterName struct {
	// Gets or sets the localized usage counter name.
	LocalizedValue *string `json:"localizedValue,omitempty"`

	// Gets or sets the usage counter name.
	Value *string `json:"value,omitempty"`
}

UsageCounterName - Definition of usage counter name.

type UsageListResult 

type UsageListResult struct {
	// Gets or sets usage.
	Value []*Usage `json:"value,omitempty"`
}

UsageListResult - The response model for the get usage operation.

type UsagesClient 

type UsagesClient struct {
	// contains filtered or unexported fields
}

UsagesClient contains the methods for the Usages group. Don't use this type directly, use NewUsagesClient() instead.

func NewUsagesClient 

func NewUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UsagesClient, error)

NewUsagesClient creates a new instance of UsagesClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*UsagesClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *UsagesClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *UsagesClientListByAutomationAccountOptions) *runtime.Pager[UsagesClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve the usage for the account id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-06-22 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - UsagesClientListByAutomationAccountOptions contains the optional parameters for the UsagesClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getUsagesOfAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewUsagesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount11",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type UsagesClientListByAutomationAccountOptions added in v0.3.0 

type UsagesClientListByAutomationAccountOptions struct {
}

UsagesClientListByAutomationAccountOptions contains the optional parameters for the UsagesClient.ListByAutomationAccount method.

type UsagesClientListByAutomationAccountResponse added in v0.3.0 

type UsagesClientListByAutomationAccountResponse struct {
	UsageListResult
}

UsagesClientListByAutomationAccountResponse contains the response from method UsagesClient.ListByAutomationAccount.

type Variable 

type Variable struct {
	// Gets or sets the properties of the variable.
	Properties *VariableProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Variable - Definition of the variable.

type VariableClient 

type VariableClient struct {
	// contains filtered or unexported fields
}

VariableClient contains the methods for the Variable group. Don't use this type directly, use NewVariableClient() instead.

func NewVariableClient 

func NewVariableClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VariableClient, error)

NewVariableClient creates a new instance of VariableClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VariableClient) CreateOrUpdate 

func (client *VariableClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, variableName string, parameters VariableCreateOrUpdateParameters, options *VariableClientCreateOrUpdateOptions) (VariableClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a variable. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. variableName - The variable name. parameters - The parameters supplied to the create or update variable operation. options - VariableClientCreateOrUpdateOptions contains the optional parameters for the VariableClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateVariable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewVariableClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"sampleAccount9",
		"sampleVariable",
		armautomation.VariableCreateOrUpdateParameters{
			Name: to.Ptr("sampleVariable"),
			Properties: &armautomation.VariableCreateOrUpdateProperties{
				Description: to.Ptr("my description"),
				IsEncrypted: to.Ptr(false),
				Value:       to.Ptr("\"ComputerName.domain.com\""),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*VariableClient) Delete 

func (client *VariableClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, variableName string, options *VariableClientDeleteOptions) (VariableClientDeleteResponse, error)

Delete - Delete the variable. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. variableName - The name of variable. options - VariableClientDeleteOptions contains the optional parameters for the VariableClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteVariable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewVariableClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"sampleAccount9",
		"sampleVariable",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*VariableClient) Get 

func (client *VariableClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, variableName string, options *VariableClientGetOptions) (VariableClientGetResponse, error)

Get - Retrieve the variable identified by variable name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. variableName - The name of variable. options - VariableClientGetOptions contains the optional parameters for the VariableClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getVariable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewVariableClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"sampleAccount9",
		"sampleVariable",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*VariableClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *VariableClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *VariableClientListByAutomationAccountOptions) *runtime.Pager[VariableClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of variables. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - VariableClientListByAutomationAccountOptions contains the optional parameters for the VariableClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listVariables_First100.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewVariableClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"sampleAccount9",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*VariableClient) Update 

func (client *VariableClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, variableName string, parameters VariableUpdateParameters, options *VariableClientUpdateOptions) (VariableClientUpdateResponse, error)

Update - Update a variable. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. variableName - The variable name. parameters - The parameters supplied to the update variable operation. options - VariableClientUpdateOptions contains the optional parameters for the VariableClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateVariable_patch.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewVariableClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"sampleAccount9",
		"sampleVariable",
		armautomation.VariableUpdateParameters{
			Name: to.Ptr("sampleVariable"),
			Properties: &armautomation.VariableUpdateProperties{
				Value: to.Ptr("\"ComputerName3.domain.com\""),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type VariableClientCreateOrUpdateOptions added in v0.3.0 

type VariableClientCreateOrUpdateOptions struct {
}

VariableClientCreateOrUpdateOptions contains the optional parameters for the VariableClient.CreateOrUpdate method.

type VariableClientCreateOrUpdateResponse added in v0.3.0 

type VariableClientCreateOrUpdateResponse struct {
	Variable
}

VariableClientCreateOrUpdateResponse contains the response from method VariableClient.CreateOrUpdate.

type VariableClientDeleteOptions added in v0.3.0 

type VariableClientDeleteOptions struct {
}

VariableClientDeleteOptions contains the optional parameters for the VariableClient.Delete method.

type VariableClientDeleteResponse added in v0.3.0 

type VariableClientDeleteResponse struct {
}

VariableClientDeleteResponse contains the response from method VariableClient.Delete.

type VariableClientGetOptions added in v0.3.0 

type VariableClientGetOptions struct {
}

VariableClientGetOptions contains the optional parameters for the VariableClient.Get method.

type VariableClientGetResponse added in v0.3.0 

type VariableClientGetResponse struct {
	Variable
}

VariableClientGetResponse contains the response from method VariableClient.Get.

type VariableClientListByAutomationAccountOptions added in v0.3.0 

type VariableClientListByAutomationAccountOptions struct {
}

VariableClientListByAutomationAccountOptions contains the optional parameters for the VariableClient.ListByAutomationAccount method.

type VariableClientListByAutomationAccountResponse added in v0.3.0 

type VariableClientListByAutomationAccountResponse struct {
	VariableListResult
}

VariableClientListByAutomationAccountResponse contains the response from method VariableClient.ListByAutomationAccount.

type VariableClientUpdateOptions added in v0.3.0 

type VariableClientUpdateOptions struct {
}

VariableClientUpdateOptions contains the optional parameters for the VariableClient.Update method.

type VariableClientUpdateResponse added in v0.3.0 

type VariableClientUpdateResponse struct {
	Variable
}

VariableClientUpdateResponse contains the response from method VariableClient.Update.

type VariableCreateOrUpdateParameters 

type VariableCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the variable.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the properties of the variable.
	Properties *VariableCreateOrUpdateProperties `json:"properties,omitempty"`
}

VariableCreateOrUpdateParameters - The parameters supplied to the create or update variable operation.

type VariableCreateOrUpdateProperties 

type VariableCreateOrUpdateProperties struct {
	// Gets or sets the description of the variable.
	Description *string `json:"description,omitempty"`

	// Gets or sets the encrypted flag of the variable.
	IsEncrypted *bool `json:"isEncrypted,omitempty"`

	// Gets or sets the value of the variable.
	Value *string `json:"value,omitempty"`
}

VariableCreateOrUpdateProperties - The properties of the create variable operation.

type VariableListResult 

type VariableListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of variables.
	Value []*Variable `json:"value,omitempty"`
}

VariableListResult - The response model for the list variables operation.

type VariableProperties 

type VariableProperties struct {
	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the encrypted flag of the variable.
	IsEncrypted *bool `json:"isEncrypted,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the value of the variable.
	Value *string `json:"value,omitempty"`
}

VariableProperties - Definition of the variable properties

func (VariableProperties) MarshalJSON 

func (v VariableProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VariableProperties.

func (*VariableProperties) UnmarshalJSON 

func (v *VariableProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VariableProperties.

type VariableUpdateParameters 

type VariableUpdateParameters struct {
	// Gets or sets the name of the variable.
	Name *string `json:"name,omitempty"`

	// Gets or sets the value of the variable.
	Properties *VariableUpdateProperties `json:"properties,omitempty"`
}

VariableUpdateParameters - The parameters supplied to the update variable operation.

func (VariableUpdateParameters) MarshalJSON 

func (v VariableUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VariableUpdateParameters.

type VariableUpdateProperties 

type VariableUpdateProperties struct {
	// Gets or sets the description of the variable.
	Description *string `json:"description,omitempty"`

	// Gets or sets the value of the variable.
	Value *string `json:"value,omitempty"`
}

VariableUpdateProperties - The properties of the update variable

type Watcher 

type Watcher struct {
	// Gets or sets the etag of the resource.
	Etag *string `json:"etag,omitempty"`

	// The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Gets or sets the watcher properties.
	Properties *WatcherProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Watcher - Definition of the watcher type.

func (Watcher) MarshalJSON 

func (w Watcher) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Watcher.

type WatcherClient 

type WatcherClient struct {
	// contains filtered or unexported fields
}

WatcherClient contains the methods for the Watcher group. Don't use this type directly, use NewWatcherClient() instead.

func NewWatcherClient 

func NewWatcherClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WatcherClient, error)

NewWatcherClient creates a new instance of WatcherClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WatcherClient) CreateOrUpdate 

func (client *WatcherClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, watcherName string, parameters Watcher, options *WatcherClientCreateOrUpdateOptions) (WatcherClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create the watcher identified by watcher name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. watcherName - The watcher name. parameters - The create or update parameters for watcher. options - WatcherClientCreateOrUpdateOptions contains the optional parameters for the WatcherClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/createOrUpdateWatcher.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"MyTestAutomationAccount",
		"MyTestWatcher",
		armautomation.Watcher{
			Properties: &armautomation.WatcherProperties{
				Description:                 to.Ptr("This is a test watcher."),
				ExecutionFrequencyInSeconds: to.Ptr[int64](60),
				ScriptName:                  to.Ptr("MyTestWatcherRunbook"),
				ScriptRunOn:                 to.Ptr("MyTestHybridWorkerGroup"),
			},
			Tags: map[string]*string{},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*WatcherClient) Delete 

func (client *WatcherClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, watcherName string, options *WatcherClientDeleteOptions) (WatcherClientDeleteResponse, error)

Delete - Delete the watcher by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. watcherName - The watcher name. options - WatcherClientDeleteOptions contains the optional parameters for the WatcherClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/deleteWatcher.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"MyTestAutomationAccount",
		"MyTestWatcher",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*WatcherClient) Get 

func (client *WatcherClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, watcherName string, options *WatcherClientGetOptions) (WatcherClientGetResponse, error)

Get - Retrieve the watcher identified by watcher name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. watcherName - The watcher name. options - WatcherClientGetOptions contains the optional parameters for the WatcherClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/getWatcher.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"MyTestAutomationAccount",
		"MyTestWatcher",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*WatcherClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *WatcherClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *WatcherClientListByAutomationAccountOptions) *runtime.Pager[WatcherClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of watchers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - WatcherClientListByAutomationAccountOptions contains the optional parameters for the WatcherClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/listWatchersByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"MyTestAutomationAccount",
		&armautomation.WatcherClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*WatcherClient) Start 

func (client *WatcherClient) Start(ctx context.Context, resourceGroupName string, automationAccountName string, watcherName string, options *WatcherClientStartOptions) (WatcherClientStartResponse, error)

Start - Resume the watcher identified by watcher name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. watcherName - The watcher name. options - WatcherClientStartOptions contains the optional parameters for the WatcherClient.Start method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/startWatcher.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Start(ctx,
		"rg",
		"MyTestAutomationAccount",
		"MyTestWatcher",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*WatcherClient) Stop 

func (client *WatcherClient) Stop(ctx context.Context, resourceGroupName string, automationAccountName string, watcherName string, options *WatcherClientStopOptions) (WatcherClientStopResponse, error)

Stop - Resume the watcher identified by watcher name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. watcherName - The watcher name. options - WatcherClientStopOptions contains the optional parameters for the WatcherClient.Stop method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/stopWatcher.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Stop(ctx,
		"rg",
		"MyTestAutomationAccount",
		"MyTestWatcher",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*WatcherClient) Update 

func (client *WatcherClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, watcherName string, parameters WatcherUpdateParameters, options *WatcherClientUpdateOptions) (WatcherClientUpdateResponse, error)

Update - Update the watcher identified by watcher name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-01-13-preview resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. watcherName - The watcher name. parameters - The update parameters for watcher. options - WatcherClientUpdateOptions contains the optional parameters for the WatcherClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/examples/updateWatcher.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWatcherClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"MyTestAutomationAccount",
		"MyTestWatcher",
		armautomation.WatcherUpdateParameters{
			Name: to.Ptr("MyTestWatcher"),
			Properties: &armautomation.WatcherUpdateProperties{
				ExecutionFrequencyInSeconds: to.Ptr[int64](600),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type WatcherClientCreateOrUpdateOptions added in v0.3.0 

type WatcherClientCreateOrUpdateOptions struct {
}

WatcherClientCreateOrUpdateOptions contains the optional parameters for the WatcherClient.CreateOrUpdate method.

type WatcherClientCreateOrUpdateResponse added in v0.3.0 

type WatcherClientCreateOrUpdateResponse struct {
	Watcher
}

WatcherClientCreateOrUpdateResponse contains the response from method WatcherClient.CreateOrUpdate.

type WatcherClientDeleteOptions added in v0.3.0 

type WatcherClientDeleteOptions struct {
}

WatcherClientDeleteOptions contains the optional parameters for the WatcherClient.Delete method.

type WatcherClientDeleteResponse added in v0.3.0 

type WatcherClientDeleteResponse struct {
}

WatcherClientDeleteResponse contains the response from method WatcherClient.Delete.

type WatcherClientGetOptions added in v0.3.0 

type WatcherClientGetOptions struct {
}

WatcherClientGetOptions contains the optional parameters for the WatcherClient.Get method.

type WatcherClientGetResponse added in v0.3.0 

type WatcherClientGetResponse struct {
	Watcher
}

WatcherClientGetResponse contains the response from method WatcherClient.Get.

type WatcherClientListByAutomationAccountOptions added in v0.3.0 

type WatcherClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

WatcherClientListByAutomationAccountOptions contains the optional parameters for the WatcherClient.ListByAutomationAccount method.

type WatcherClientListByAutomationAccountResponse added in v0.3.0 

type WatcherClientListByAutomationAccountResponse struct {
	WatcherListResult
}

WatcherClientListByAutomationAccountResponse contains the response from method WatcherClient.ListByAutomationAccount.

type WatcherClientStartOptions added in v0.3.0 

type WatcherClientStartOptions struct {
}

WatcherClientStartOptions contains the optional parameters for the WatcherClient.Start method.

type WatcherClientStartResponse added in v0.3.0 

type WatcherClientStartResponse struct {
}

WatcherClientStartResponse contains the response from method WatcherClient.Start.

type WatcherClientStopOptions added in v0.3.0 

type WatcherClientStopOptions struct {
}

WatcherClientStopOptions contains the optional parameters for the WatcherClient.Stop method.

type WatcherClientStopResponse added in v0.3.0 

type WatcherClientStopResponse struct {
}

WatcherClientStopResponse contains the response from method WatcherClient.Stop.

type WatcherClientUpdateOptions added in v0.3.0 

type WatcherClientUpdateOptions struct {
}

WatcherClientUpdateOptions contains the optional parameters for the WatcherClient.Update method.

type WatcherClientUpdateResponse added in v0.3.0 

type WatcherClientUpdateResponse struct {
	Watcher
}

WatcherClientUpdateResponse contains the response from method WatcherClient.Update.

type WatcherListResult 

type WatcherListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of watchers.
	Value []*Watcher `json:"value,omitempty"`
}

WatcherListResult - The response model for the list watcher operation.

type WatcherProperties 

type WatcherProperties struct {
	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the frequency at which the watcher is invoked.
	ExecutionFrequencyInSeconds *int64 `json:"executionFrequencyInSeconds,omitempty"`

	// Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
	ScriptName *string `json:"scriptName,omitempty"`

	// Gets or sets the parameters of the script.
	ScriptParameters map[string]*string `json:"scriptParameters,omitempty"`

	// Gets or sets the name of the hybrid worker group the watcher will run on.
	ScriptRunOn *string `json:"scriptRunOn,omitempty"`

	// READ-ONLY; Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty" azure:"ro"`

	// READ-ONLY; Details of the user who last modified the watcher.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty" azure:"ro"`

	// READ-ONLY; Gets the current status of the watcher.
	Status *string `json:"status,omitempty" azure:"ro"`
}

WatcherProperties - Definition of the watcher properties

func (WatcherProperties) MarshalJSON 

func (w WatcherProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WatcherProperties.

func (*WatcherProperties) UnmarshalJSON 

func (w *WatcherProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WatcherProperties.

type WatcherUpdateParameters 

type WatcherUpdateParameters struct {
	// Gets or sets the name of the resource.
	Name *string `json:"name,omitempty"`

	// Gets or sets the watcher update properties.
	Properties *WatcherUpdateProperties `json:"properties,omitempty"`
}

func (WatcherUpdateParameters) MarshalJSON 

func (w WatcherUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WatcherUpdateParameters.

type WatcherUpdateProperties 

type WatcherUpdateProperties struct {
	// Gets or sets the frequency at which the watcher is invoked.
	ExecutionFrequencyInSeconds *int64 `json:"executionFrequencyInSeconds,omitempty"`
}

WatcherUpdateProperties - The properties of the update watcher operation.

type Webhook 

type Webhook struct {
	// Gets or sets the webhook properties.
	Properties *WebhookProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Webhook - Definition of the webhook type.

type WebhookClient 

type WebhookClient struct {
	// contains filtered or unexported fields
}

WebhookClient contains the methods for the Webhook group. Don't use this type directly, use NewWebhookClient() instead.

func NewWebhookClient 

func NewWebhookClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WebhookClient, error)

NewWebhookClient creates a new instance of WebhookClient with the specified values. subscriptionID - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WebhookClient) CreateOrUpdate 

func (client *WebhookClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, automationAccountName string, webhookName string, parameters WebhookCreateOrUpdateParameters, options *WebhookClientCreateOrUpdateOptions) (WebhookClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create the webhook identified by webhook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2015-10-31 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. webhookName - The webhook name. parameters - The create or update parameters for webhook. options - WebhookClientCreateOrUpdateOptions contains the optional parameters for the WebhookClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWebhook.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWebhookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount33",
		"TestWebhook",
		armautomation.WebhookCreateOrUpdateParameters{
			Name: to.Ptr("TestWebhook"),
			Properties: &armautomation.WebhookCreateOrUpdateProperties{
				ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-29T22:18:13.7002872Z"); return t }()),
				IsEnabled:  to.Ptr(true),
				Runbook: &armautomation.RunbookAssociationProperty{
					Name: to.Ptr("TestRunbook"),
				},
				URI: to.Ptr("<uri>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*WebhookClient) Delete 

func (client *WebhookClient) Delete(ctx context.Context, resourceGroupName string, automationAccountName string, webhookName string, options *WebhookClientDeleteOptions) (WebhookClientDeleteResponse, error)

Delete - Delete the webhook by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2015-10-31 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. webhookName - The webhook name. options - WebhookClientDeleteOptions contains the optional parameters for the WebhookClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteWebhook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWebhookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg",
		"myAutomationAccount33",
		"TestWebhook",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*WebhookClient) GenerateURI 

func (client *WebhookClient) GenerateURI(ctx context.Context, resourceGroupName string, automationAccountName string, options *WebhookClientGenerateURIOptions) (WebhookClientGenerateURIResponse, error)

GenerateURI - Generates a Uri for use in creating a webhook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2015-10-31 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - WebhookClientGenerateURIOptions contains the optional parameters for the WebhookClient.GenerateURI method.

func (*WebhookClient) Get 

func (client *WebhookClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, webhookName string, options *WebhookClientGetOptions) (WebhookClientGetResponse, error)

Get - Retrieve the webhook identified by webhook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2015-10-31 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. webhookName - The webhook name. options - WebhookClientGetOptions contains the optional parameters for the WebhookClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWebhook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWebhookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg",
		"myAutomationAccount33",
		"TestWebhook",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*WebhookClient) NewListByAutomationAccountPager added in v0.5.0 

func (client *WebhookClient) NewListByAutomationAccountPager(resourceGroupName string, automationAccountName string, options *WebhookClientListByAutomationAccountOptions) *runtime.Pager[WebhookClientListByAutomationAccountResponse]

NewListByAutomationAccountPager - Retrieve a list of webhooks. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2015-10-31 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. options - WebhookClientListByAutomationAccountOptions contains the optional parameters for the WebhookClient.ListByAutomationAccount method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWebhooksByAutomationAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWebhookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByAutomationAccountPager("rg",
		"myAutomationAccount33",
		&armautomation.WebhookClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*WebhookClient) Update 

func (client *WebhookClient) Update(ctx context.Context, resourceGroupName string, automationAccountName string, webhookName string, parameters WebhookUpdateParameters, options *WebhookClientUpdateOptions) (WebhookClientUpdateResponse, error)

Update - Update the webhook identified by webhook name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2015-10-31 resourceGroupName - Name of an Azure Resource group. automationAccountName - The name of the automation account. webhookName - The webhook name. parameters - The update parameters for webhook. options - WebhookClientUpdateOptions contains the optional parameters for the WebhookClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWebhook.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWebhookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"rg",
		"myAutomationAccount33",
		"TestWebhook",
		armautomation.WebhookUpdateParameters{
			Name: to.Ptr("TestWebhook"),
			Properties: &armautomation.WebhookUpdateProperties{
				Description: to.Ptr("updated webhook"),
				IsEnabled:   to.Ptr(false),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type WebhookClientCreateOrUpdateOptions added in v0.3.0 

type WebhookClientCreateOrUpdateOptions struct {
}

WebhookClientCreateOrUpdateOptions contains the optional parameters for the WebhookClient.CreateOrUpdate method.

type WebhookClientCreateOrUpdateResponse added in v0.3.0 

type WebhookClientCreateOrUpdateResponse struct {
	Webhook
}

WebhookClientCreateOrUpdateResponse contains the response from method WebhookClient.CreateOrUpdate.

type WebhookClientDeleteOptions added in v0.3.0 

type WebhookClientDeleteOptions struct {
}

WebhookClientDeleteOptions contains the optional parameters for the WebhookClient.Delete method.

type WebhookClientDeleteResponse added in v0.3.0 

type WebhookClientDeleteResponse struct {
}

WebhookClientDeleteResponse contains the response from method WebhookClient.Delete.

type WebhookClientGenerateURIOptions added in v0.3.0 

type WebhookClientGenerateURIOptions struct {
}

WebhookClientGenerateURIOptions contains the optional parameters for the WebhookClient.GenerateURI method.

type WebhookClientGenerateURIResponse added in v0.3.0 

type WebhookClientGenerateURIResponse struct {
	Value *string
}

WebhookClientGenerateURIResponse contains the response from method WebhookClient.GenerateURI.

type WebhookClientGetOptions added in v0.3.0 

type WebhookClientGetOptions struct {
}

WebhookClientGetOptions contains the optional parameters for the WebhookClient.Get method.

type WebhookClientGetResponse added in v0.3.0 

type WebhookClientGetResponse struct {
	Webhook
}

WebhookClientGetResponse contains the response from method WebhookClient.Get.

type WebhookClientListByAutomationAccountOptions added in v0.3.0 

type WebhookClientListByAutomationAccountOptions struct {
	// The filter to apply on the operation.
	Filter *string
}

WebhookClientListByAutomationAccountOptions contains the optional parameters for the WebhookClient.ListByAutomationAccount method.

type WebhookClientListByAutomationAccountResponse added in v0.3.0 

type WebhookClientListByAutomationAccountResponse struct {
	WebhookListResult
}

WebhookClientListByAutomationAccountResponse contains the response from method WebhookClient.ListByAutomationAccount.

type WebhookClientUpdateOptions added in v0.3.0 

type WebhookClientUpdateOptions struct {
}

WebhookClientUpdateOptions contains the optional parameters for the WebhookClient.Update method.

type WebhookClientUpdateResponse added in v0.3.0 

type WebhookClientUpdateResponse struct {
	Webhook
}

WebhookClientUpdateResponse contains the response from method WebhookClient.Update.

type WebhookCreateOrUpdateParameters 

type WebhookCreateOrUpdateParameters struct {
	// REQUIRED; Gets or sets the name of the webhook.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Gets or sets the properties of the webhook.
	Properties *WebhookCreateOrUpdateProperties `json:"properties,omitempty"`
}

WebhookCreateOrUpdateParameters - The parameters supplied to the create or update webhook operation.

type WebhookCreateOrUpdateProperties 

type WebhookCreateOrUpdateProperties struct {
	// Gets or sets the expiry time.
	ExpiryTime *time.Time `json:"expiryTime,omitempty"`

	// Gets or sets the value of the enabled flag of webhook.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Gets or sets the parameters of the job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the name of the hybrid worker group the webhook job will run on.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the runbook.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty"`

	// Gets or sets the uri.
	URI *string `json:"uri,omitempty"`
}

WebhookCreateOrUpdateProperties - The properties of the create webhook operation.

func (WebhookCreateOrUpdateProperties) MarshalJSON 

func (w WebhookCreateOrUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebhookCreateOrUpdateProperties.

func (*WebhookCreateOrUpdateProperties) UnmarshalJSON 

func (w *WebhookCreateOrUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebhookCreateOrUpdateProperties.

type WebhookListResult 

type WebhookListResult struct {
	// Gets or sets the next link.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets a list of webhooks.
	Value []*Webhook `json:"value,omitempty"`
}

WebhookListResult - The response model for the list webhook operation.

type WebhookProperties 

type WebhookProperties struct {
	// Gets or sets the creation time.
	CreationTime *time.Time `json:"creationTime,omitempty"`

	// Gets or sets the description.
	Description *string `json:"description,omitempty"`

	// Gets or sets the expiry time.
	ExpiryTime *time.Time `json:"expiryTime,omitempty"`

	// Gets or sets the value of the enabled flag of the webhook.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Gets or sets the last invoked time.
	LastInvokedTime *time.Time `json:"lastInvokedTime,omitempty"`

	// Details of the user who last modified the Webhook
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// Gets or sets the last modified time.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the name of the hybrid worker group the webhook job will run on.
	RunOn *string `json:"runOn,omitempty"`

	// Gets or sets the runbook the webhook is associated with.
	Runbook *RunbookAssociationProperty `json:"runbook,omitempty"`

	// Gets or sets the webhook uri.
	URI *string `json:"uri,omitempty"`
}

WebhookProperties - Definition of the webhook properties

func (WebhookProperties) MarshalJSON 

func (w WebhookProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebhookProperties.

func (*WebhookProperties) UnmarshalJSON 

func (w *WebhookProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebhookProperties.

type WebhookUpdateParameters 

type WebhookUpdateParameters struct {
	// Gets or sets the name of the webhook.
	Name *string `json:"name,omitempty"`

	// Gets or sets the value of the webhook.
	Properties *WebhookUpdateProperties `json:"properties,omitempty"`
}

WebhookUpdateParameters - The parameters supplied to the update webhook operation.

func (WebhookUpdateParameters) MarshalJSON 

func (w WebhookUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebhookUpdateParameters.

type WebhookUpdateProperties 

type WebhookUpdateProperties struct {
	// Gets or sets the description of the webhook.
	Description *string `json:"description,omitempty"`

	// Gets or sets the value of the enabled flag of webhook.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Gets or sets the parameters of the job.
	Parameters map[string]*string `json:"parameters,omitempty"`

	// Gets or sets the name of the hybrid worker group the webhook job will run on.
	RunOn *string `json:"runOn,omitempty"`
}

WebhookUpdateProperties - The properties of the update webhook.

func (WebhookUpdateProperties) MarshalJSON 

func (w WebhookUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebhookUpdateProperties.

type WindowsProperties 

type WindowsProperties struct {
	// KB numbers excluded from the software update configuration.
	ExcludedKbNumbers []*string `json:"excludedKbNumbers,omitempty"`

	// KB numbers included from the software update configuration.
	IncludedKbNumbers []*string `json:"includedKbNumbers,omitempty"`

	// Update classification included in the software update configuration. A comma separated string with required values
	IncludedUpdateClassifications *WindowsUpdateClasses `json:"includedUpdateClassifications,omitempty"`

	// Reboot setting for the software update configuration.
	RebootSetting *string `json:"rebootSetting,omitempty"`
}

WindowsProperties - Windows specific update configuration.

func (WindowsProperties) MarshalJSON 

func (w WindowsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WindowsProperties.

type WindowsUpdateClasses 

type WindowsUpdateClasses string

WindowsUpdateClasses - Update classification included in the software update configuration. A comma separated string with required values 

const (
	WindowsUpdateClassesCritical     WindowsUpdateClasses = "Critical"
	WindowsUpdateClassesDefinition   WindowsUpdateClasses = "Definition"
	WindowsUpdateClassesFeaturePack  WindowsUpdateClasses = "FeaturePack"
	WindowsUpdateClassesSecurity     WindowsUpdateClasses = "Security"
	WindowsUpdateClassesServicePack  WindowsUpdateClasses = "ServicePack"
	WindowsUpdateClassesTools        WindowsUpdateClasses = "Tools"
	WindowsUpdateClassesUnclassified WindowsUpdateClasses = "Unclassified"
	WindowsUpdateClassesUpdateRollup WindowsUpdateClasses = "UpdateRollup"
	WindowsUpdateClassesUpdates      WindowsUpdateClasses = "Updates"
)

func PossibleWindowsUpdateClassesValues 

func PossibleWindowsUpdateClassesValues() []WindowsUpdateClasses

PossibleWindowsUpdateClassesValues returns the possible values for the WindowsUpdateClasses const type.

type WorkerType 

type WorkerType string

WorkerType - Type of the HybridWorker. 

const (
	WorkerTypeHybridV1 WorkerType = "HybridV1"
	WorkerTypeHybridV2 WorkerType = "HybridV2"
)

func PossibleWorkerTypeValues 

func PossibleWorkerTypeValues() []WorkerType

PossibleWorkerTypeValues returns the possible values for the WorkerType const type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.