armstoragepool

package module
v0.2.1 Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2022 License: MIT Imports: 14 Imported by: 1

README

Azure Storage Pool Module for Go

PkgGoDev

The armstoragepool module provides operations for working with Azure Storage Pool.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Storage Pool module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Storage Pool. 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 Storage Pool 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 := armstoragepool.NewDiskPoolsClient(<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{
    Host: arm.AzureChina,
}
client := armstoragepool.NewDiskPoolsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Storage Pool 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 ACL

type ACL struct {
	// REQUIRED; iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client".
	InitiatorIqn *string `json:"initiatorIqn,omitempty"`

	// REQUIRED; List of LUN names mapped to the ACL.
	MappedLuns []*string `json:"mappedLuns,omitempty"`
}

ACL - Access Control List (ACL) for an iSCSI Target; defines LUN masking policy

func (ACL) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ACL.

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.

func (CreatedByType) ToPtr

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type Disk

type Disk struct {
	// REQUIRED; Unique Azure Resource ID of the Managed Disk.
	ID *string `json:"id,omitempty"`
}

Disk - Azure Managed Disk to attach to the Disk Pool.

type DiskPool

type DiskPool struct {
	// REQUIRED; The geo-location where the resource lives.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of Disk Pool.
	Properties *DiskPoolProperties `json:"properties,omitempty"`

	// Determines the SKU of the Disk pool
	SKU *SKU `json:"sku,omitempty"`

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

	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure resource id. Indicates if this resource is managed by another Azure resource.
	ManagedBy *string `json:"managedBy,omitempty" azure:"ro"`

	// READ-ONLY; List of Azure resource ids that manage this resource.
	ManagedByExtended []*string `json:"managedByExtended,omitempty" azure:"ro"`

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

	// READ-ONLY; Resource metadata required by ARM RPC
	SystemData *SystemMetadata `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DiskPool - Response for Disk Pool request.

func (DiskPool) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPool.

type DiskPoolCreate

type DiskPoolCreate struct {
	// REQUIRED; The geo-location where the resource lives.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties for Disk Pool create request.
	Properties *DiskPoolCreateProperties `json:"properties,omitempty"`

	// REQUIRED; Determines the SKU of the Disk Pool
	SKU *SKU `json:"sku,omitempty"`

	// Azure resource id. Indicates if this resource is managed by another Azure resource.
	ManagedBy *string `json:"managedBy,omitempty"`

	// List of Azure resource ids that manage this resource.
	ManagedByExtended []*string `json:"managedByExtended,omitempty"`

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

	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DiskPoolCreate - Request payload for create or update Disk Pool request.

func (DiskPoolCreate) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolCreate.

type DiskPoolCreateProperties

type DiskPoolCreateProperties struct {
	// REQUIRED; Azure Resource ID of a Subnet for the Disk Pool.
	SubnetID *string `json:"subnetId,omitempty"`

	// List of additional capabilities for a Disk Pool.
	AdditionalCapabilities []*string `json:"additionalCapabilities,omitempty"`

	// Logical zone for Disk Pool resource; example: ["1"].
	AvailabilityZones []*string `json:"availabilityZones,omitempty"`

	// List of Azure Managed Disks to attach to a Disk Pool.
	Disks []*Disk `json:"disks,omitempty"`
}

DiskPoolCreateProperties - Properties for Disk Pool create or update request.

func (DiskPoolCreateProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolCreateProperties.

type DiskPoolListResult

type DiskPoolListResult struct {
	// REQUIRED; An array of Disk pool objects.
	Value []*DiskPool `json:"value,omitempty"`

	// READ-ONLY; URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DiskPoolListResult - List of Disk Pools

func (DiskPoolListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolListResult.

type DiskPoolProperties

type DiskPoolProperties struct {
	// REQUIRED; Logical zone for Disk Pool resource; example: ["1"].
	AvailabilityZones []*string `json:"availabilityZones,omitempty"`

	// REQUIRED; Operational status of the Disk Pool.
	Status *OperationalStatus `json:"status,omitempty"`

	// REQUIRED; Azure Resource ID of a Subnet for the Disk Pool.
	SubnetID *string `json:"subnetId,omitempty"`

	// READ-ONLY; State of the operation on the resource.
	ProvisioningState *ProvisioningStates `json:"provisioningState,omitempty" azure:"ro"`

	// List of additional capabilities for Disk Pool.
	AdditionalCapabilities []*string `json:"additionalCapabilities,omitempty"`

	// List of Azure Managed Disks to attach to a Disk Pool.
	Disks []*Disk `json:"disks,omitempty"`
}

DiskPoolProperties - Disk Pool response properties.

func (DiskPoolProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolProperties.

type DiskPoolTier

type DiskPoolTier string

DiskPoolTier - SKU of the VM host part of the Disk Pool deployment

const (
	DiskPoolTierBasic    DiskPoolTier = "Basic"
	DiskPoolTierPremium  DiskPoolTier = "Premium"
	DiskPoolTierStandard DiskPoolTier = "Standard"
)

func PossibleDiskPoolTierValues

func PossibleDiskPoolTierValues() []DiskPoolTier

PossibleDiskPoolTierValues returns the possible values for the DiskPoolTier const type.

func (DiskPoolTier) ToPtr

func (c DiskPoolTier) ToPtr() *DiskPoolTier

ToPtr returns a *DiskPoolTier pointing to the current value.

type DiskPoolUpdate

type DiskPoolUpdate struct {
	// REQUIRED; Properties for Disk Pool update request.
	Properties *DiskPoolUpdateProperties `json:"properties,omitempty"`

	// Azure resource id. Indicates if this resource is managed by another Azure resource.
	ManagedBy *string `json:"managedBy,omitempty"`

	// List of Azure resource ids that manage this resource.
	ManagedByExtended []*string `json:"managedByExtended,omitempty"`

	// Determines the SKU of the Disk Pool
	SKU *SKU `json:"sku,omitempty"`

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

DiskPoolUpdate - Request payload for Update Disk Pool request.

func (DiskPoolUpdate) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolUpdate.

type DiskPoolUpdateProperties

type DiskPoolUpdateProperties struct {
	// List of Azure Managed Disks to attach to a Disk Pool.
	Disks []*Disk `json:"disks,omitempty"`
}

DiskPoolUpdateProperties - Properties for Disk Pool update request.

func (DiskPoolUpdateProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolUpdateProperties.

type DiskPoolZoneInfo

type DiskPoolZoneInfo struct {
	// READ-ONLY; List of additional capabilities for Disk Pool.
	AdditionalCapabilities []*string `json:"additionalCapabilities,omitempty" azure:"ro"`

	// READ-ONLY; Logical zone for Disk Pool resource; example: ["1"].
	AvailabilityZones []*string `json:"availabilityZones,omitempty" azure:"ro"`

	// READ-ONLY; Determines the SKU of VM deployed for Disk Pool
	SKU *SKU `json:"sku,omitempty" azure:"ro"`
}

DiskPoolZoneInfo - Disk Pool SKU Details

func (DiskPoolZoneInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolZoneInfo.

type DiskPoolZoneListResult

type DiskPoolZoneListResult struct {
	// READ-ONLY; URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of Disk Pool Skus.
	Value []*DiskPoolZoneInfo `json:"value,omitempty" azure:"ro"`
}

DiskPoolZoneListResult - List Disk Pool skus operation response.

func (DiskPoolZoneListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiskPoolZoneListResult.

type DiskPoolZonesClient

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

DiskPoolZonesClient contains the methods for the DiskPoolZones group. Don't use this type directly, use NewDiskPoolZonesClient() instead.

func NewDiskPoolZonesClient

func NewDiskPoolZonesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DiskPoolZonesClient

NewDiskPoolZonesClient creates a new instance of DiskPoolZonesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DiskPoolZonesClient) List

List - Lists available Disk Pool Skus in an Azure location. If the operation fails it returns an *azcore.ResponseError type. location - The location of the resource. options - DiskPoolZonesClientListOptions contains the optional parameters for the DiskPoolZonesClient.List method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPoolZones_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolZonesClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}
Output:

type DiskPoolZonesClientListOptions added in v0.2.0

type DiskPoolZonesClientListOptions struct {
}

DiskPoolZonesClientListOptions contains the optional parameters for the DiskPoolZonesClient.List method.

type DiskPoolZonesClientListPager added in v0.2.0

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

DiskPoolZonesClientListPager provides operations for iterating over paged responses.

func (*DiskPoolZonesClientListPager) Err added in v0.2.0

Err returns the last error encountered while paging.

func (*DiskPoolZonesClientListPager) NextPage added in v0.2.0

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DiskPoolZonesClientListPager) PageResponse added in v0.2.0

PageResponse returns the current DiskPoolZonesClientListResponse page.

type DiskPoolZonesClientListResponse added in v0.2.0

type DiskPoolZonesClientListResponse struct {
	DiskPoolZonesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolZonesClientListResponse contains the response from method DiskPoolZonesClient.List.

type DiskPoolZonesClientListResult added in v0.2.0

type DiskPoolZonesClientListResult struct {
	DiskPoolZoneListResult
}

DiskPoolZonesClientListResult contains the result from method DiskPoolZonesClient.List.

type DiskPoolsClient

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

DiskPoolsClient contains the methods for the DiskPools group. Don't use this type directly, use NewDiskPoolsClient() instead.

func NewDiskPoolsClient

func NewDiskPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DiskPoolsClient

NewDiskPoolsClient creates a new instance of DiskPoolsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DiskPoolsClient) BeginCreateOrUpdate

func (client *DiskPoolsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolCreatePayload DiskPoolCreate, options *DiskPoolsClientBeginCreateOrUpdateOptions) (DiskPoolsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. diskPoolCreatePayload - Request payload for Disk Pool create operation options - DiskPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the DiskPoolsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Put.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/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		armstoragepool.DiskPoolCreate{
			Location: to.StringPtr("<location>"),
			Properties: &armstoragepool.DiskPoolCreateProperties{
				AvailabilityZones: []*string{
					to.StringPtr("1")},
				Disks: []*armstoragepool.Disk{
					{
						ID: to.StringPtr("<id>"),
					},
					{
						ID: to.StringPtr("<id>"),
					}},
				SubnetID: to.StringPtr("<subnet-id>"),
			},
			SKU: &armstoragepool.SKU{
				Name: to.StringPtr("<name>"),
				Tier: to.StringPtr("<tier>"),
			},
			Tags: map[string]*string{
				"key": to.StringPtr("value"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DiskPoolsClientCreateOrUpdateResult)
}
Output:

func (*DiskPoolsClient) BeginDeallocate

func (client *DiskPoolsClient) BeginDeallocate(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsClientBeginDeallocateOptions) (DiskPoolsClientDeallocatePollerResponse, error)

BeginDeallocate - Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - DiskPoolsClientBeginDeallocateOptions contains the optional parameters for the DiskPoolsClient.BeginDeallocate method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Deallocate.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDeallocate(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*DiskPoolsClient) BeginDelete

func (client *DiskPoolsClient) BeginDelete(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsClientBeginDeleteOptions) (DiskPoolsClientDeletePollerResponse, error)

BeginDelete - Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - DiskPoolsClientBeginDeleteOptions contains the optional parameters for the DiskPoolsClient.BeginDelete method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Delete.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*DiskPoolsClient) BeginStart

func (client *DiskPoolsClient) BeginStart(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsClientBeginStartOptions) (DiskPoolsClientStartPollerResponse, error)

BeginStart - The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - DiskPoolsClientBeginStartOptions contains the optional parameters for the DiskPoolsClient.BeginStart method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Start.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStart(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*DiskPoolsClient) BeginUpdate

func (client *DiskPoolsClient) BeginUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolUpdatePayload DiskPoolUpdate, options *DiskPoolsClientBeginUpdateOptions) (DiskPoolsClientUpdatePollerResponse, error)

BeginUpdate - Update a Disk pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. diskPoolUpdatePayload - Request payload for Disk Pool update operation. options - DiskPoolsClientBeginUpdateOptions contains the optional parameters for the DiskPoolsClient.BeginUpdate method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Patch.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/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		armstoragepool.DiskPoolUpdate{
			Properties: &armstoragepool.DiskPoolUpdateProperties{
				Disks: []*armstoragepool.Disk{
					{
						ID: to.StringPtr("<id>"),
					},
					{
						ID: to.StringPtr("<id>"),
					}},
			},
			SKU: &armstoragepool.SKU{
				Name: to.StringPtr("<name>"),
				Tier: to.StringPtr("<tier>"),
			},
			Tags: map[string]*string{
				"key": to.StringPtr("value"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DiskPoolsClientUpdateResult)
}
Output:

func (*DiskPoolsClient) BeginUpgrade

func (client *DiskPoolsClient) BeginUpgrade(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsClientBeginUpgradeOptions) (DiskPoolsClientUpgradePollerResponse, error)

BeginUpgrade - Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - DiskPoolsClientBeginUpgradeOptions contains the optional parameters for the DiskPoolsClient.BeginUpgrade method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Upgrade.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpgrade(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*DiskPoolsClient) Get

func (client *DiskPoolsClient) Get(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsClientGetOptions) (DiskPoolsClientGetResponse, error)

Get - Get a Disk pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - DiskPoolsClientGetOptions contains the optional parameters for the DiskPoolsClient.Get method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DiskPoolsClientGetResult)
}
Output:

func (*DiskPoolsClient) ListByResourceGroup

func (client *DiskPoolsClient) ListByResourceGroup(resourceGroupName string, options *DiskPoolsClientListByResourceGroupOptions) *DiskPoolsClientListByResourceGroupPager

ListByResourceGroup - Gets a list of DiskPools in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - DiskPoolsClientListByResourceGroupOptions contains the optional parameters for the DiskPoolsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_ListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}
Output:

func (*DiskPoolsClient) ListBySubscription

ListBySubscription - Gets a list of Disk Pools in a subscription If the operation fails it returns an *azcore.ResponseError type. options - DiskPoolsClientListBySubscriptionOptions contains the optional parameters for the DiskPoolsClient.ListBySubscription method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_ListBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}
Output:

func (*DiskPoolsClient) ListOutboundNetworkDependenciesEndpoints

func (client *DiskPoolsClient) ListOutboundNetworkDependenciesEndpoints(resourceGroupName string, diskPoolName string, options *DiskPoolsClientListOutboundNetworkDependenciesEndpointsOptions) *DiskPoolsClientListOutboundNetworkDependenciesEndpointsPager

ListOutboundNetworkDependenciesEndpoints - Gets the network endpoints of all outbound dependencies of a Disk Pool If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - DiskPoolsClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the DiskPoolsClient.ListOutboundNetworkDependenciesEndpoints method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/DiskPools_GetOutboundNetworkDependencies.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewDiskPoolsClient("<subscription-id>", cred, nil)
	pager := client.ListOutboundNetworkDependenciesEndpoints("<resource-group-name>",
		"<disk-pool-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}
Output:

type DiskPoolsClientBeginCreateOrUpdateOptions added in v0.2.0

type DiskPoolsClientBeginCreateOrUpdateOptions struct {
}

DiskPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the DiskPoolsClient.BeginCreateOrUpdate method.

type DiskPoolsClientBeginDeallocateOptions added in v0.2.0

type DiskPoolsClientBeginDeallocateOptions struct {
}

DiskPoolsClientBeginDeallocateOptions contains the optional parameters for the DiskPoolsClient.BeginDeallocate method.

type DiskPoolsClientBeginDeleteOptions added in v0.2.0

type DiskPoolsClientBeginDeleteOptions struct {
}

DiskPoolsClientBeginDeleteOptions contains the optional parameters for the DiskPoolsClient.BeginDelete method.

type DiskPoolsClientBeginStartOptions added in v0.2.0

type DiskPoolsClientBeginStartOptions struct {
}

DiskPoolsClientBeginStartOptions contains the optional parameters for the DiskPoolsClient.BeginStart method.

type DiskPoolsClientBeginUpdateOptions added in v0.2.0

type DiskPoolsClientBeginUpdateOptions struct {
}

DiskPoolsClientBeginUpdateOptions contains the optional parameters for the DiskPoolsClient.BeginUpdate method.

type DiskPoolsClientBeginUpgradeOptions added in v0.2.0

type DiskPoolsClientBeginUpgradeOptions struct {
}

DiskPoolsClientBeginUpgradeOptions contains the optional parameters for the DiskPoolsClient.BeginUpgrade method.

type DiskPoolsClientCreateOrUpdatePoller added in v0.2.0

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

DiskPoolsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DiskPoolsClientCreateOrUpdatePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*DiskPoolsClientCreateOrUpdatePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DiskPoolsClientCreateOrUpdateResponse will be returned.

func (*DiskPoolsClientCreateOrUpdatePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DiskPoolsClientCreateOrUpdatePoller) ResumeToken added in v0.2.0

func (p *DiskPoolsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DiskPoolsClientCreateOrUpdatePollerResponse added in v0.2.0

type DiskPoolsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientCreateOrUpdatePollerResponse contains the response from method DiskPoolsClient.CreateOrUpdate.

func (DiskPoolsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DiskPoolsClientCreateOrUpdatePollerResponse) Resume added in v0.2.0

Resume rehydrates a DiskPoolsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DiskPoolsClientCreateOrUpdateResponse added in v0.2.0

type DiskPoolsClientCreateOrUpdateResponse struct {
	DiskPoolsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientCreateOrUpdateResponse contains the response from method DiskPoolsClient.CreateOrUpdate.

type DiskPoolsClientCreateOrUpdateResult added in v0.2.0

type DiskPoolsClientCreateOrUpdateResult struct {
	DiskPool
}

DiskPoolsClientCreateOrUpdateResult contains the result from method DiskPoolsClient.CreateOrUpdate.

type DiskPoolsClientDeallocatePoller added in v0.2.0

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

DiskPoolsClientDeallocatePoller provides polling facilities until the operation reaches a terminal state.

func (*DiskPoolsClientDeallocatePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*DiskPoolsClientDeallocatePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DiskPoolsClientDeallocateResponse will be returned.

func (*DiskPoolsClientDeallocatePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DiskPoolsClientDeallocatePoller) ResumeToken added in v0.2.0

func (p *DiskPoolsClientDeallocatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DiskPoolsClientDeallocatePollerResponse added in v0.2.0

type DiskPoolsClientDeallocatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsClientDeallocatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientDeallocatePollerResponse contains the response from method DiskPoolsClient.Deallocate.

func (DiskPoolsClientDeallocatePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DiskPoolsClientDeallocatePollerResponse) Resume added in v0.2.0

Resume rehydrates a DiskPoolsClientDeallocatePollerResponse from the provided client and resume token.

type DiskPoolsClientDeallocateResponse added in v0.2.0

type DiskPoolsClientDeallocateResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientDeallocateResponse contains the response from method DiskPoolsClient.Deallocate.

type DiskPoolsClientDeletePoller added in v0.2.0

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

DiskPoolsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DiskPoolsClientDeletePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*DiskPoolsClientDeletePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DiskPoolsClientDeleteResponse will be returned.

func (*DiskPoolsClientDeletePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DiskPoolsClientDeletePoller) ResumeToken added in v0.2.0

func (p *DiskPoolsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DiskPoolsClientDeletePollerResponse added in v0.2.0

type DiskPoolsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientDeletePollerResponse contains the response from method DiskPoolsClient.Delete.

func (DiskPoolsClientDeletePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DiskPoolsClientDeletePollerResponse) Resume added in v0.2.0

Resume rehydrates a DiskPoolsClientDeletePollerResponse from the provided client and resume token.

type DiskPoolsClientDeleteResponse added in v0.2.0

type DiskPoolsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientDeleteResponse contains the response from method DiskPoolsClient.Delete.

type DiskPoolsClientGetOptions added in v0.2.0

type DiskPoolsClientGetOptions struct {
}

DiskPoolsClientGetOptions contains the optional parameters for the DiskPoolsClient.Get method.

type DiskPoolsClientGetResponse added in v0.2.0

type DiskPoolsClientGetResponse struct {
	DiskPoolsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientGetResponse contains the response from method DiskPoolsClient.Get.

type DiskPoolsClientGetResult added in v0.2.0

type DiskPoolsClientGetResult struct {
	DiskPool
}

DiskPoolsClientGetResult contains the result from method DiskPoolsClient.Get.

type DiskPoolsClientListByResourceGroupOptions added in v0.2.0

type DiskPoolsClientListByResourceGroupOptions struct {
}

DiskPoolsClientListByResourceGroupOptions contains the optional parameters for the DiskPoolsClient.ListByResourceGroup method.

type DiskPoolsClientListByResourceGroupPager added in v0.2.0

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

DiskPoolsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*DiskPoolsClientListByResourceGroupPager) Err added in v0.2.0

Err returns the last error encountered while paging.

func (*DiskPoolsClientListByResourceGroupPager) NextPage added in v0.2.0

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DiskPoolsClientListByResourceGroupPager) PageResponse added in v0.2.0

PageResponse returns the current DiskPoolsClientListByResourceGroupResponse page.

type DiskPoolsClientListByResourceGroupResponse added in v0.2.0

type DiskPoolsClientListByResourceGroupResponse struct {
	DiskPoolsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientListByResourceGroupResponse contains the response from method DiskPoolsClient.ListByResourceGroup.

type DiskPoolsClientListByResourceGroupResult added in v0.2.0

type DiskPoolsClientListByResourceGroupResult struct {
	DiskPoolListResult
}

DiskPoolsClientListByResourceGroupResult contains the result from method DiskPoolsClient.ListByResourceGroup.

type DiskPoolsClientListBySubscriptionOptions added in v0.2.0

type DiskPoolsClientListBySubscriptionOptions struct {
}

DiskPoolsClientListBySubscriptionOptions contains the optional parameters for the DiskPoolsClient.ListBySubscription method.

type DiskPoolsClientListBySubscriptionPager added in v0.2.0

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

DiskPoolsClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*DiskPoolsClientListBySubscriptionPager) Err added in v0.2.0

Err returns the last error encountered while paging.

func (*DiskPoolsClientListBySubscriptionPager) NextPage added in v0.2.0

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DiskPoolsClientListBySubscriptionPager) PageResponse added in v0.2.0

PageResponse returns the current DiskPoolsClientListBySubscriptionResponse page.

type DiskPoolsClientListBySubscriptionResponse added in v0.2.0

type DiskPoolsClientListBySubscriptionResponse struct {
	DiskPoolsClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientListBySubscriptionResponse contains the response from method DiskPoolsClient.ListBySubscription.

type DiskPoolsClientListBySubscriptionResult added in v0.2.0

type DiskPoolsClientListBySubscriptionResult struct {
	DiskPoolListResult
}

DiskPoolsClientListBySubscriptionResult contains the result from method DiskPoolsClient.ListBySubscription.

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsOptions added in v0.2.0

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsOptions struct {
}

DiskPoolsClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the DiskPoolsClient.ListOutboundNetworkDependenciesEndpoints method.

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsPager added in v0.2.0

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

DiskPoolsClientListOutboundNetworkDependenciesEndpointsPager provides operations for iterating over paged responses.

func (*DiskPoolsClientListOutboundNetworkDependenciesEndpointsPager) Err added in v0.2.0

Err returns the last error encountered while paging.

func (*DiskPoolsClientListOutboundNetworkDependenciesEndpointsPager) NextPage added in v0.2.0

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DiskPoolsClientListOutboundNetworkDependenciesEndpointsPager) PageResponse added in v0.2.0

PageResponse returns the current DiskPoolsClientListOutboundNetworkDependenciesEndpointsResponse page.

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsResponse added in v0.2.0

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsResponse struct {
	DiskPoolsClientListOutboundNetworkDependenciesEndpointsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method DiskPoolsClient.ListOutboundNetworkDependenciesEndpoints.

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsResult added in v0.2.0

type DiskPoolsClientListOutboundNetworkDependenciesEndpointsResult struct {
	OutboundEnvironmentEndpointList
}

DiskPoolsClientListOutboundNetworkDependenciesEndpointsResult contains the result from method DiskPoolsClient.ListOutboundNetworkDependenciesEndpoints.

type DiskPoolsClientStartPoller added in v0.2.0

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

DiskPoolsClientStartPoller provides polling facilities until the operation reaches a terminal state.

func (*DiskPoolsClientStartPoller) Done added in v0.2.0

func (p *DiskPoolsClientStartPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DiskPoolsClientStartPoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DiskPoolsClientStartResponse will be returned.

func (*DiskPoolsClientStartPoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DiskPoolsClientStartPoller) ResumeToken added in v0.2.0

func (p *DiskPoolsClientStartPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DiskPoolsClientStartPollerResponse added in v0.2.0

type DiskPoolsClientStartPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsClientStartPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientStartPollerResponse contains the response from method DiskPoolsClient.Start.

func (DiskPoolsClientStartPollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DiskPoolsClientStartPollerResponse) Resume added in v0.2.0

Resume rehydrates a DiskPoolsClientStartPollerResponse from the provided client and resume token.

type DiskPoolsClientStartResponse added in v0.2.0

type DiskPoolsClientStartResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientStartResponse contains the response from method DiskPoolsClient.Start.

type DiskPoolsClientUpdatePoller added in v0.2.0

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

DiskPoolsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DiskPoolsClientUpdatePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*DiskPoolsClientUpdatePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DiskPoolsClientUpdateResponse will be returned.

func (*DiskPoolsClientUpdatePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DiskPoolsClientUpdatePoller) ResumeToken added in v0.2.0

func (p *DiskPoolsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DiskPoolsClientUpdatePollerResponse added in v0.2.0

type DiskPoolsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientUpdatePollerResponse contains the response from method DiskPoolsClient.Update.

func (DiskPoolsClientUpdatePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DiskPoolsClientUpdatePollerResponse) Resume added in v0.2.0

Resume rehydrates a DiskPoolsClientUpdatePollerResponse from the provided client and resume token.

type DiskPoolsClientUpdateResponse added in v0.2.0

type DiskPoolsClientUpdateResponse struct {
	DiskPoolsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientUpdateResponse contains the response from method DiskPoolsClient.Update.

type DiskPoolsClientUpdateResult added in v0.2.0

type DiskPoolsClientUpdateResult struct {
	DiskPool
}

DiskPoolsClientUpdateResult contains the result from method DiskPoolsClient.Update.

type DiskPoolsClientUpgradePoller added in v0.2.0

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

DiskPoolsClientUpgradePoller provides polling facilities until the operation reaches a terminal state.

func (*DiskPoolsClientUpgradePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*DiskPoolsClientUpgradePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DiskPoolsClientUpgradeResponse will be returned.

func (*DiskPoolsClientUpgradePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DiskPoolsClientUpgradePoller) ResumeToken added in v0.2.0

func (p *DiskPoolsClientUpgradePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DiskPoolsClientUpgradePollerResponse added in v0.2.0

type DiskPoolsClientUpgradePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsClientUpgradePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientUpgradePollerResponse contains the response from method DiskPoolsClient.Upgrade.

func (DiskPoolsClientUpgradePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DiskPoolsClientUpgradePollerResponse) Resume added in v0.2.0

Resume rehydrates a DiskPoolsClientUpgradePollerResponse from the provided client and resume token.

type DiskPoolsClientUpgradeResponse added in v0.2.0

type DiskPoolsClientUpgradeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DiskPoolsClientUpgradeResponse contains the response from method DiskPoolsClient.Upgrade.

type EndpointDependency

type EndpointDependency struct {
	// The domain name of the dependency.
	DomainName *string `json:"domainName,omitempty"`

	// The IP Addresses and Ports used when connecting to DomainName.
	EndpointDetails []*EndpointDetail `json:"endpointDetails,omitempty"`
}

EndpointDependency - A domain name that a service is reached at, including details of the current connection status.

func (EndpointDependency) MarshalJSON

func (e EndpointDependency) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointDependency.

type EndpointDetail

type EndpointDetail struct {
	// An IP Address that Domain Name currently resolves to.
	IPAddress *string `json:"ipAddress,omitempty"`

	// Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.
	IsAccessible *bool `json:"isAccessible,omitempty"`

	// The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress
	// at this Port.
	Latency *float64 `json:"latency,omitempty"`

	// The port an endpoint is connected to.
	Port *int32 `json:"port,omitempty"`
}

EndpointDetail - Current TCP connectivity information from the App Service Environment to a single endpoint.

type Error

type Error struct {
	// RP error response.
	Error *ErrorResponse `json:"error,omitempty"`
}

Error - The resource management error response.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

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

ErrorAdditionalInfo - The resource management error additional info.

type ErrorResponse

type ErrorResponse struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorResponse `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorResponse - The resource management error response.

func (ErrorResponse) MarshalJSON

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

type IscsiLun

type IscsiLun struct {
	// REQUIRED; Azure Resource ID of the Managed Disk.
	ManagedDiskAzureResourceID *string `json:"managedDiskAzureResourceId,omitempty"`

	// REQUIRED; User defined name for iSCSI LUN; example: "lun0"
	Name *string `json:"name,omitempty"`

	// READ-ONLY; Specifies the Logical Unit Number of the iSCSI LUN.
	Lun *int32 `json:"lun,omitempty" azure:"ro"`
}

IscsiLun - LUN to expose the Azure Managed Disk.

type IscsiTarget

type IscsiTarget struct {
	// REQUIRED; Properties for iSCSI Target operations.
	Properties *IscsiTargetProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure resource id. Indicates if this resource is managed by another Azure resource.
	ManagedBy *string `json:"managedBy,omitempty" azure:"ro"`

	// READ-ONLY; List of Azure resource ids that manage this resource.
	ManagedByExtended []*string `json:"managedByExtended,omitempty" azure:"ro"`

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

	// READ-ONLY; Resource metadata required by ARM RPC
	SystemData *SystemMetadata `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IscsiTarget - Response for iSCSI Target requests.

func (IscsiTarget) MarshalJSON

func (i IscsiTarget) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTarget.

type IscsiTargetACLMode

type IscsiTargetACLMode string

IscsiTargetACLMode - ACL mode for iSCSI Target.

const (
	IscsiTargetACLModeDynamic IscsiTargetACLMode = "Dynamic"
	IscsiTargetACLModeStatic  IscsiTargetACLMode = "Static"
)

func PossibleIscsiTargetACLModeValues

func PossibleIscsiTargetACLModeValues() []IscsiTargetACLMode

PossibleIscsiTargetACLModeValues returns the possible values for the IscsiTargetACLMode const type.

func (IscsiTargetACLMode) ToPtr

ToPtr returns a *IscsiTargetACLMode pointing to the current value.

type IscsiTargetCreate

type IscsiTargetCreate struct {
	// REQUIRED; Properties for iSCSI Target create request.
	Properties *IscsiTargetCreateProperties `json:"properties,omitempty"`

	// Azure resource id. Indicates if this resource is managed by another Azure resource.
	ManagedBy *string `json:"managedBy,omitempty"`

	// List of Azure resource ids that manage this resource.
	ManagedByExtended []*string `json:"managedByExtended,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IscsiTargetCreate - Payload for iSCSI Target create or update requests.

func (IscsiTargetCreate) MarshalJSON

func (i IscsiTargetCreate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTargetCreate.

type IscsiTargetCreateProperties

type IscsiTargetCreateProperties struct {
	// REQUIRED; Mode for Target connectivity.
	ACLMode *IscsiTargetACLMode `json:"aclMode,omitempty"`

	// List of LUNs to be exposed through iSCSI Target.
	Luns []*IscsiLun `json:"luns,omitempty"`

	// Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
	StaticACLs []*ACL `json:"staticAcls,omitempty"`

	// iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
	TargetIqn *string `json:"targetIqn,omitempty"`
}

IscsiTargetCreateProperties - Properties for iSCSI Target create or update request.

func (IscsiTargetCreateProperties) MarshalJSON

func (i IscsiTargetCreateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTargetCreateProperties.

type IscsiTargetList

type IscsiTargetList struct {
	// REQUIRED; An array of iSCSI Targets in a Disk Pool.
	Value []*IscsiTarget `json:"value,omitempty"`

	// READ-ONLY; URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

IscsiTargetList - List of iSCSI Targets.

func (IscsiTargetList) MarshalJSON

func (i IscsiTargetList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTargetList.

type IscsiTargetProperties

type IscsiTargetProperties struct {
	// REQUIRED; Mode for Target connectivity.
	ACLMode *IscsiTargetACLMode `json:"aclMode,omitempty"`

	// REQUIRED; Operational status of the iSCSI Target.
	Status *OperationalStatus `json:"status,omitempty"`

	// REQUIRED; iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
	TargetIqn *string `json:"targetIqn,omitempty"`

	// READ-ONLY; State of the operation on the resource.
	ProvisioningState *ProvisioningStates `json:"provisioningState,omitempty" azure:"ro"`

	// List of private IPv4 addresses to connect to the iSCSI Target.
	Endpoints []*string `json:"endpoints,omitempty"`

	// List of LUNs to be exposed through iSCSI Target.
	Luns []*IscsiLun `json:"luns,omitempty"`

	// The port used by iSCSI Target portal group.
	Port *int32 `json:"port,omitempty"`

	// Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
	StaticACLs []*ACL `json:"staticAcls,omitempty"`

	// READ-ONLY; List of identifiers for active sessions on the iSCSI target
	Sessions []*string `json:"sessions,omitempty" azure:"ro"`
}

IscsiTargetProperties - Response properties for iSCSI Target operations.

func (IscsiTargetProperties) MarshalJSON

func (i IscsiTargetProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTargetProperties.

type IscsiTargetUpdate

type IscsiTargetUpdate struct {
	// REQUIRED; Properties for iSCSI Target update request.
	Properties *IscsiTargetUpdateProperties `json:"properties,omitempty"`

	// Azure resource id. Indicates if this resource is managed by another Azure resource.
	ManagedBy *string `json:"managedBy,omitempty"`

	// List of Azure resource ids that manage this resource.
	ManagedByExtended []*string `json:"managedByExtended,omitempty"`

	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IscsiTargetUpdate - Payload for iSCSI Target update requests.

func (IscsiTargetUpdate) MarshalJSON

func (i IscsiTargetUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTargetUpdate.

type IscsiTargetUpdateProperties

type IscsiTargetUpdateProperties struct {
	// List of LUNs to be exposed through iSCSI Target.
	Luns []*IscsiLun `json:"luns,omitempty"`

	// Access Control List (ACL) for an iSCSI Target; defines LUN masking policy
	StaticACLs []*ACL `json:"staticAcls,omitempty"`
}

IscsiTargetUpdateProperties - Properties for iSCSI Target update request.

func (IscsiTargetUpdateProperties) MarshalJSON

func (i IscsiTargetUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IscsiTargetUpdateProperties.

type IscsiTargetsClient

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

IscsiTargetsClient contains the methods for the IscsiTargets group. Don't use this type directly, use NewIscsiTargetsClient() instead.

func NewIscsiTargetsClient

func NewIscsiTargetsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *IscsiTargetsClient

NewIscsiTargetsClient creates a new instance of IscsiTargetsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*IscsiTargetsClient) BeginCreateOrUpdate

func (client *IscsiTargetsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string, iscsiTargetCreatePayload IscsiTargetCreate, options *IscsiTargetsClientBeginCreateOrUpdateOptions) (IscsiTargetsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or Update an iSCSI Target. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. iscsiTargetName - The name of the iSCSI Target. iscsiTargetCreatePayload - Request payload for iSCSI Target create operation. options - IscsiTargetsClientBeginCreateOrUpdateOptions contains the optional parameters for the IscsiTargetsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/IscsiTargets_Put.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/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewIscsiTargetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		"<iscsi-target-name>",
		armstoragepool.IscsiTargetCreate{
			Properties: &armstoragepool.IscsiTargetCreateProperties{
				ACLMode: armstoragepool.IscsiTargetACLMode("Dynamic").ToPtr(),
				Luns: []*armstoragepool.IscsiLun{
					{
						Name:                       to.StringPtr("<name>"),
						ManagedDiskAzureResourceID: to.StringPtr("<managed-disk-azure-resource-id>"),
					}},
				TargetIqn: to.StringPtr("<target-iqn>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IscsiTargetsClientCreateOrUpdateResult)
}
Output:

func (*IscsiTargetsClient) BeginDelete

func (client *IscsiTargetsClient) BeginDelete(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string, options *IscsiTargetsClientBeginDeleteOptions) (IscsiTargetsClientDeletePollerResponse, error)

BeginDelete - Delete an iSCSI Target. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. iscsiTargetName - The name of the iSCSI Target. options - IscsiTargetsClientBeginDeleteOptions contains the optional parameters for the IscsiTargetsClient.BeginDelete method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/IscsiTargets_Delete.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewIscsiTargetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		"<iscsi-target-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*IscsiTargetsClient) BeginUpdate

func (client *IscsiTargetsClient) BeginUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string, iscsiTargetUpdatePayload IscsiTargetUpdate, options *IscsiTargetsClientBeginUpdateOptions) (IscsiTargetsClientUpdatePollerResponse, error)

BeginUpdate - Update an iSCSI Target. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. iscsiTargetName - The name of the iSCSI Target. iscsiTargetUpdatePayload - Request payload for iSCSI Target update operation. options - IscsiTargetsClientBeginUpdateOptions contains the optional parameters for the IscsiTargetsClient.BeginUpdate method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/IscsiTargets_Patch.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/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewIscsiTargetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		"<iscsi-target-name>",
		armstoragepool.IscsiTargetUpdate{
			Properties: &armstoragepool.IscsiTargetUpdateProperties{
				Luns: []*armstoragepool.IscsiLun{
					{
						Name:                       to.StringPtr("<name>"),
						ManagedDiskAzureResourceID: to.StringPtr("<managed-disk-azure-resource-id>"),
					}},
				StaticACLs: []*armstoragepool.ACL{
					{
						InitiatorIqn: to.StringPtr("<initiator-iqn>"),
						MappedLuns: []*string{
							to.StringPtr("lun0")},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IscsiTargetsClientUpdateResult)
}
Output:

func (*IscsiTargetsClient) Get

func (client *IscsiTargetsClient) Get(ctx context.Context, resourceGroupName string, diskPoolName string, iscsiTargetName string, options *IscsiTargetsClientGetOptions) (IscsiTargetsClientGetResponse, error)

Get - Get an iSCSI Target. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. iscsiTargetName - The name of the iSCSI Target. options - IscsiTargetsClientGetOptions contains the optional parameters for the IscsiTargetsClient.Get method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/IscsiTargets_Get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewIscsiTargetsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<disk-pool-name>",
		"<iscsi-target-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IscsiTargetsClientGetResult)
}
Output:

func (*IscsiTargetsClient) ListByDiskPool

func (client *IscsiTargetsClient) ListByDiskPool(resourceGroupName string, diskPoolName string, options *IscsiTargetsClientListByDiskPoolOptions) *IscsiTargetsClientListByDiskPoolPager

ListByDiskPool - Get iSCSI Targets in a Disk pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. diskPoolName - The name of the Disk Pool. options - IscsiTargetsClientListByDiskPoolOptions contains the optional parameters for the IscsiTargetsClient.ListByDiskPool method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/IscsiTargets_ListByDiskPool.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewIscsiTargetsClient("<subscription-id>", cred, nil)
	pager := client.ListByDiskPool("<resource-group-name>",
		"<disk-pool-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}
Output:

type IscsiTargetsClientBeginCreateOrUpdateOptions added in v0.2.0

type IscsiTargetsClientBeginCreateOrUpdateOptions struct {
}

IscsiTargetsClientBeginCreateOrUpdateOptions contains the optional parameters for the IscsiTargetsClient.BeginCreateOrUpdate method.

type IscsiTargetsClientBeginDeleteOptions added in v0.2.0

type IscsiTargetsClientBeginDeleteOptions struct {
}

IscsiTargetsClientBeginDeleteOptions contains the optional parameters for the IscsiTargetsClient.BeginDelete method.

type IscsiTargetsClientBeginUpdateOptions added in v0.2.0

type IscsiTargetsClientBeginUpdateOptions struct {
}

IscsiTargetsClientBeginUpdateOptions contains the optional parameters for the IscsiTargetsClient.BeginUpdate method.

type IscsiTargetsClientCreateOrUpdatePoller added in v0.2.0

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

IscsiTargetsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*IscsiTargetsClientCreateOrUpdatePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*IscsiTargetsClientCreateOrUpdatePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IscsiTargetsClientCreateOrUpdateResponse will be returned.

func (*IscsiTargetsClientCreateOrUpdatePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IscsiTargetsClientCreateOrUpdatePoller) ResumeToken added in v0.2.0

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IscsiTargetsClientCreateOrUpdatePollerResponse added in v0.2.0

type IscsiTargetsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IscsiTargetsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientCreateOrUpdatePollerResponse contains the response from method IscsiTargetsClient.CreateOrUpdate.

func (IscsiTargetsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IscsiTargetsClientCreateOrUpdatePollerResponse) Resume added in v0.2.0

Resume rehydrates a IscsiTargetsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type IscsiTargetsClientCreateOrUpdateResponse added in v0.2.0

type IscsiTargetsClientCreateOrUpdateResponse struct {
	IscsiTargetsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientCreateOrUpdateResponse contains the response from method IscsiTargetsClient.CreateOrUpdate.

type IscsiTargetsClientCreateOrUpdateResult added in v0.2.0

type IscsiTargetsClientCreateOrUpdateResult struct {
	IscsiTarget
}

IscsiTargetsClientCreateOrUpdateResult contains the result from method IscsiTargetsClient.CreateOrUpdate.

type IscsiTargetsClientDeletePoller added in v0.2.0

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

IscsiTargetsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*IscsiTargetsClientDeletePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*IscsiTargetsClientDeletePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IscsiTargetsClientDeleteResponse will be returned.

func (*IscsiTargetsClientDeletePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IscsiTargetsClientDeletePoller) ResumeToken added in v0.2.0

func (p *IscsiTargetsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IscsiTargetsClientDeletePollerResponse added in v0.2.0

type IscsiTargetsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IscsiTargetsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientDeletePollerResponse contains the response from method IscsiTargetsClient.Delete.

func (IscsiTargetsClientDeletePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IscsiTargetsClientDeletePollerResponse) Resume added in v0.2.0

Resume rehydrates a IscsiTargetsClientDeletePollerResponse from the provided client and resume token.

type IscsiTargetsClientDeleteResponse added in v0.2.0

type IscsiTargetsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientDeleteResponse contains the response from method IscsiTargetsClient.Delete.

type IscsiTargetsClientGetOptions added in v0.2.0

type IscsiTargetsClientGetOptions struct {
}

IscsiTargetsClientGetOptions contains the optional parameters for the IscsiTargetsClient.Get method.

type IscsiTargetsClientGetResponse added in v0.2.0

type IscsiTargetsClientGetResponse struct {
	IscsiTargetsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientGetResponse contains the response from method IscsiTargetsClient.Get.

type IscsiTargetsClientGetResult added in v0.2.0

type IscsiTargetsClientGetResult struct {
	IscsiTarget
}

IscsiTargetsClientGetResult contains the result from method IscsiTargetsClient.Get.

type IscsiTargetsClientListByDiskPoolOptions added in v0.2.0

type IscsiTargetsClientListByDiskPoolOptions struct {
}

IscsiTargetsClientListByDiskPoolOptions contains the optional parameters for the IscsiTargetsClient.ListByDiskPool method.

type IscsiTargetsClientListByDiskPoolPager added in v0.2.0

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

IscsiTargetsClientListByDiskPoolPager provides operations for iterating over paged responses.

func (*IscsiTargetsClientListByDiskPoolPager) Err added in v0.2.0

Err returns the last error encountered while paging.

func (*IscsiTargetsClientListByDiskPoolPager) NextPage added in v0.2.0

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IscsiTargetsClientListByDiskPoolPager) PageResponse added in v0.2.0

PageResponse returns the current IscsiTargetsClientListByDiskPoolResponse page.

type IscsiTargetsClientListByDiskPoolResponse added in v0.2.0

type IscsiTargetsClientListByDiskPoolResponse struct {
	IscsiTargetsClientListByDiskPoolResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientListByDiskPoolResponse contains the response from method IscsiTargetsClient.ListByDiskPool.

type IscsiTargetsClientListByDiskPoolResult added in v0.2.0

type IscsiTargetsClientListByDiskPoolResult struct {
	IscsiTargetList
}

IscsiTargetsClientListByDiskPoolResult contains the result from method IscsiTargetsClient.ListByDiskPool.

type IscsiTargetsClientUpdatePoller added in v0.2.0

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

IscsiTargetsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*IscsiTargetsClientUpdatePoller) Done added in v0.2.0

Done returns true if the LRO has reached a terminal state.

func (*IscsiTargetsClientUpdatePoller) FinalResponse added in v0.2.0

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IscsiTargetsClientUpdateResponse will be returned.

func (*IscsiTargetsClientUpdatePoller) Poll added in v0.2.0

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IscsiTargetsClientUpdatePoller) ResumeToken added in v0.2.0

func (p *IscsiTargetsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IscsiTargetsClientUpdatePollerResponse added in v0.2.0

type IscsiTargetsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IscsiTargetsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientUpdatePollerResponse contains the response from method IscsiTargetsClient.Update.

func (IscsiTargetsClientUpdatePollerResponse) PollUntilDone added in v0.2.0

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IscsiTargetsClientUpdatePollerResponse) Resume added in v0.2.0

Resume rehydrates a IscsiTargetsClientUpdatePollerResponse from the provided client and resume token.

type IscsiTargetsClientUpdateResponse added in v0.2.0

type IscsiTargetsClientUpdateResponse struct {
	IscsiTargetsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IscsiTargetsClientUpdateResponse contains the response from method IscsiTargetsClient.Update.

type IscsiTargetsClientUpdateResult added in v0.2.0

type IscsiTargetsClientUpdateResult struct {
	IscsiTarget
}

IscsiTargetsClientUpdateResult contains the result from method IscsiTargetsClient.Update.

type OperationDisplay added in v0.2.0

type OperationDisplay struct {
	// REQUIRED; Localized friendly description for the operation, as it should be shown to the user.
	Description *string `json:"description,omitempty"`

	// REQUIRED; Localized friendly name for the operation, as it should be shown to the user.
	Operation *string `json:"operation,omitempty"`

	// REQUIRED; Localized friendly form of the resource provider name.
	Provider *string `json:"provider,omitempty"`

	// REQUIRED; Localized friendly form of the resource type related to this action/operation.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Metadata about an operation.

type OperationListResult added in v0.2.0

type OperationListResult struct {
	// REQUIRED; An array of operations supported by the StoragePool RP.
	Value []*RPOperation `json:"value,omitempty"`

	// URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult - List of operations supported by the RP.

func (OperationListResult) MarshalJSON added in v0.2.0

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationalStatus

type OperationalStatus string

OperationalStatus - Operational status of the resource.

const (
	OperationalStatusHealthy            OperationalStatus = "Healthy"
	OperationalStatusInvalid            OperationalStatus = "Invalid"
	OperationalStatusRunning            OperationalStatus = "Running"
	OperationalStatusStopped            OperationalStatus = "Stopped"
	OperationalStatusStoppedDeallocated OperationalStatus = "Stopped (deallocated)"
	OperationalStatusUnhealthy          OperationalStatus = "Unhealthy"
	OperationalStatusUnknown            OperationalStatus = "Unknown"
	OperationalStatusUpdating           OperationalStatus = "Updating"
)

func PossibleOperationalStatusValues

func PossibleOperationalStatusValues() []OperationalStatus

PossibleOperationalStatusValues returns the possible values for the OperationalStatus const type.

func (OperationalStatus) ToPtr

ToPtr returns a *OperationalStatus pointing to the current value.

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

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) List

List - Gets a list of StoragePool operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/Operations_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewOperationsClient(cred, nil)
	res, err := client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.OperationsClientListResult)
}
Output:

type OperationsClientListOptions added in v0.2.0

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.2.0

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List.

type OutboundEnvironmentEndpoint

type OutboundEnvironmentEndpoint struct {
	// The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active
	// Directory.
	Category *string `json:"category,omitempty"`

	// The endpoints that the App Service Environment reaches the service at.
	Endpoints []*EndpointDependency `json:"endpoints,omitempty"`
}

OutboundEnvironmentEndpoint - Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.

func (OutboundEnvironmentEndpoint) MarshalJSON

func (o OutboundEnvironmentEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEnvironmentEndpoint.

type OutboundEnvironmentEndpointList

type OutboundEnvironmentEndpointList struct {
	// REQUIRED; Collection of resources.
	Value []*OutboundEnvironmentEndpoint `json:"value,omitempty"`

	// READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

OutboundEnvironmentEndpointList - Collection of Outbound Environment Endpoints

func (OutboundEnvironmentEndpointList) MarshalJSON

func (o OutboundEnvironmentEndpointList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEnvironmentEndpointList.

type ProvisioningStates

type ProvisioningStates string

ProvisioningStates - Provisioning state of the iSCSI Target.

const (
	ProvisioningStatesCanceled  ProvisioningStates = "Canceled"
	ProvisioningStatesCreating  ProvisioningStates = "Creating"
	ProvisioningStatesDeleting  ProvisioningStates = "Deleting"
	ProvisioningStatesFailed    ProvisioningStates = "Failed"
	ProvisioningStatesInvalid   ProvisioningStates = "Invalid"
	ProvisioningStatesPending   ProvisioningStates = "Pending"
	ProvisioningStatesSucceeded ProvisioningStates = "Succeeded"
	ProvisioningStatesUpdating  ProvisioningStates = "Updating"
)

func PossibleProvisioningStatesValues

func PossibleProvisioningStatesValues() []ProvisioningStates

PossibleProvisioningStatesValues returns the possible values for the ProvisioningStates const type.

func (ProvisioningStates) ToPtr

ToPtr returns a *ProvisioningStates pointing to the current value.

type ProxyResource

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

type RPOperation added in v0.2.0

type RPOperation struct {
	// REQUIRED; Additional metadata about RP operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// REQUIRED; Indicates whether the operation applies to data-plane.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// REQUIRED; The name of the operation being performed on this particular object
	Name *string `json:"name,omitempty"`

	// Indicates the action type.
	ActionType *string `json:"actionType,omitempty"`

	// The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.
	Origin *string `json:"origin,omitempty"`
}

RPOperation - Description of a StoragePool RP Operation

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - ARM resource model definition.

type ResourceSKUCapability

type ResourceSKUCapability struct {
	// READ-ONLY; Capability name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Capability value
	Value *string `json:"value,omitempty" azure:"ro"`
}

ResourceSKUCapability - Capability a resource SKU has.

type ResourceSKUInfo

type ResourceSKUInfo struct {
	// READ-ONLY; StoragePool RP API version
	APIVersion *string `json:"apiVersion,omitempty" azure:"ro"`

	// READ-ONLY; List of additional capabilities for StoragePool resource.
	Capabilities []*ResourceSKUCapability `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; Zones and zone capabilities in those locations where the SKU is available.
	LocationInfo *ResourceSKULocationInfo `json:"locationInfo,omitempty" azure:"ro"`

	// READ-ONLY; Sku name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; StoragePool resource type
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions []*ResourceSKURestrictions `json:"restrictions,omitempty" azure:"ro"`

	// READ-ONLY; Sku tier
	Tier *string `json:"tier,omitempty" azure:"ro"`
}

ResourceSKUInfo - Resource SKU Details

func (ResourceSKUInfo) MarshalJSON

func (r ResourceSKUInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUInfo.

type ResourceSKUListResult

type ResourceSKUListResult struct {
	// URI to fetch the next section of the paginated response.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of StoragePool resource skus.
	Value []*ResourceSKUInfo `json:"value,omitempty"`
}

ResourceSKUListResult - List Disk Pool skus operation response.

func (ResourceSKUListResult) MarshalJSON

func (r ResourceSKUListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUListResult.

type ResourceSKULocationInfo

type ResourceSKULocationInfo struct {
	// READ-ONLY; Location of the SKU
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Details of capabilities available to a SKU in specific zones.
	ZoneDetails []*ResourceSKUZoneDetails `json:"zoneDetails,omitempty" azure:"ro"`

	// READ-ONLY; List of availability zones where the SKU is supported.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

ResourceSKULocationInfo - Zone and capability info for resource sku

func (ResourceSKULocationInfo) MarshalJSON

func (r ResourceSKULocationInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKULocationInfo.

type ResourceSKURestrictionInfo

type ResourceSKURestrictionInfo struct {
	// READ-ONLY; Locations where the SKU is restricted
	Locations []*string `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY; List of availability zones where the SKU is restricted.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

ResourceSKURestrictionInfo - Describes an available Compute SKU Restriction Information.

func (ResourceSKURestrictionInfo) MarshalJSON

func (r ResourceSKURestrictionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKURestrictionInfo.

type ResourceSKURestrictions

type ResourceSKURestrictions struct {
	// READ-ONLY; The reason for restriction.
	ReasonCode *ResourceSKURestrictionsReasonCode `json:"reasonCode,omitempty" azure:"ro"`

	// READ-ONLY; The information about the restriction where the SKU cannot be used.
	RestrictionInfo *ResourceSKURestrictionInfo `json:"restrictionInfo,omitempty" azure:"ro"`

	// READ-ONLY; The type of restrictions.
	Type *ResourceSKURestrictionsType `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where
	// the SKU is restricted.
	Values []*string `json:"values,omitempty" azure:"ro"`
}

ResourceSKURestrictions - Describes scaling information of a SKU.

func (ResourceSKURestrictions) MarshalJSON

func (r ResourceSKURestrictions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKURestrictions.

type ResourceSKURestrictionsReasonCode

type ResourceSKURestrictionsReasonCode string

ResourceSKURestrictionsReasonCode - The reason for restriction.

const (
	ResourceSKURestrictionsReasonCodeQuotaID                     ResourceSKURestrictionsReasonCode = "QuotaId"
	ResourceSKURestrictionsReasonCodeNotAvailableForSubscription ResourceSKURestrictionsReasonCode = "NotAvailableForSubscription"
)

func PossibleResourceSKURestrictionsReasonCodeValues

func PossibleResourceSKURestrictionsReasonCodeValues() []ResourceSKURestrictionsReasonCode

PossibleResourceSKURestrictionsReasonCodeValues returns the possible values for the ResourceSKURestrictionsReasonCode const type.

func (ResourceSKURestrictionsReasonCode) ToPtr

ToPtr returns a *ResourceSKURestrictionsReasonCode pointing to the current value.

type ResourceSKURestrictionsType

type ResourceSKURestrictionsType string

ResourceSKURestrictionsType - The type of restrictions.

const (
	ResourceSKURestrictionsTypeLocation ResourceSKURestrictionsType = "Location"
	ResourceSKURestrictionsTypeZone     ResourceSKURestrictionsType = "Zone"
)

func PossibleResourceSKURestrictionsTypeValues

func PossibleResourceSKURestrictionsTypeValues() []ResourceSKURestrictionsType

PossibleResourceSKURestrictionsTypeValues returns the possible values for the ResourceSKURestrictionsType const type.

func (ResourceSKURestrictionsType) ToPtr

ToPtr returns a *ResourceSKURestrictionsType pointing to the current value.

type ResourceSKUZoneDetails

type ResourceSKUZoneDetails struct {
	// READ-ONLY; A list of capabilities that are available for the SKU in the specified list of zones.
	Capabilities []*ResourceSKUCapability `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; The set of zones that the SKU is available in with the specified capabilities.
	Name []*string `json:"name,omitempty" azure:"ro"`
}

ResourceSKUZoneDetails - Describes The zonal capabilities of a SKU.

func (ResourceSKUZoneDetails) MarshalJSON

func (r ResourceSKUZoneDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUZoneDetails.

type ResourceSKUsClient

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

ResourceSKUsClient contains the methods for the ResourceSKUs group. Don't use this type directly, use NewResourceSKUsClient() instead.

func NewResourceSKUsClient

func NewResourceSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ResourceSKUsClient

NewResourceSKUsClient creates a new instance of ResourceSKUsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ResourceSKUsClient) List

List - Lists available StoragePool resources and skus in an Azure location. If the operation fails it returns an *azcore.ResponseError type. location - The location of the resource. options - ResourceSKUsClientListOptions contains the optional parameters for the ResourceSKUsClient.List method.

Example

x-ms-original-file: specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/examples/Skus_List.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagepool/armstoragepool"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragepool.NewResourceSKUsClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}
Output:

type ResourceSKUsClientListOptions added in v0.2.0

type ResourceSKUsClientListOptions struct {
}

ResourceSKUsClientListOptions contains the optional parameters for the ResourceSKUsClient.List method.

type ResourceSKUsClientListPager added in v0.2.0

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

ResourceSKUsClientListPager provides operations for iterating over paged responses.

func (*ResourceSKUsClientListPager) Err added in v0.2.0

Err returns the last error encountered while paging.

func (*ResourceSKUsClientListPager) NextPage added in v0.2.0

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ResourceSKUsClientListPager) PageResponse added in v0.2.0

PageResponse returns the current ResourceSKUsClientListResponse page.

type ResourceSKUsClientListResponse added in v0.2.0

type ResourceSKUsClientListResponse struct {
	ResourceSKUsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceSKUsClientListResponse contains the response from method ResourceSKUsClient.List.

type ResourceSKUsClientListResult added in v0.2.0

type ResourceSKUsClientListResult struct {
	ResourceSKUListResult
}

ResourceSKUsClientListResult contains the result from method ResourceSKUsClient.List.

type SKU

type SKU struct {
	// REQUIRED; Sku name
	Name *string `json:"name,omitempty"`

	// Sku tier
	Tier *string `json:"tier,omitempty"`
}

SKU - Sku for ARM resource

type SystemMetadata

type SystemMetadata 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 type of identity that last modified the resource.
	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"`
}

SystemMetadata - Metadata pertaining to creation and last modification of the resource.

func (SystemMetadata) MarshalJSON

func (s SystemMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemMetadata.

func (*SystemMetadata) UnmarshalJSON

func (s *SystemMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemMetadata.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location 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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL