armstoragepool

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 16, 2021 License: MIT Imports: 15 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 {
	TrackedResource
	// REQUIRED; Properties of Disk Pool.
	Properties *DiskPoolProperties `json:"properties,omitempty"`

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

	// 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; Resource metadata required by ARM RPC
	SystemData *SystemMetadata `json:"systemData,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.

func (*DiskPoolZonesClient) List 

func (client *DiskPoolZonesClient) List(location string, options *DiskPoolZonesListOptions) *DiskPoolZonesListPager

List - Lists available Disk Pool Skus in an Azure location. If the operation fails it returns the *Error error type.

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 pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

type DiskPoolZonesListOptions 

type DiskPoolZonesListOptions struct {
}

DiskPoolZonesListOptions contains the optional parameters for the DiskPoolZones.List method.

type DiskPoolZonesListPager 

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

DiskPoolZonesListPager provides operations for iterating over paged responses.

func (*DiskPoolZonesListPager) Err 

func (p *DiskPoolZonesListPager) Err() error

Err returns the last error encountered while paging.

func (*DiskPoolZonesListPager) NextPage 

func (p *DiskPoolZonesListPager) NextPage(ctx context.Context) bool

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

func (*DiskPoolZonesListPager) PageResponse 

func (p *DiskPoolZonesListPager) PageResponse() DiskPoolZonesListResponse

PageResponse returns the current DiskPoolZonesListResponse page.

type DiskPoolZonesListResponse 

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

DiskPoolZonesListResponse contains the response from method DiskPoolZones.List.

type DiskPoolZonesListResult 

type DiskPoolZonesListResult struct {
	DiskPoolZoneListResult
}

DiskPoolZonesListResult contains the result from method DiskPoolZones.List.

type DiskPoolsBeginCreateOrUpdateOptions 

type DiskPoolsBeginCreateOrUpdateOptions struct {
}

DiskPoolsBeginCreateOrUpdateOptions contains the optional parameters for the DiskPools.BeginCreateOrUpdate method.

type DiskPoolsBeginDeallocateOptions 

type DiskPoolsBeginDeallocateOptions struct {
}

DiskPoolsBeginDeallocateOptions contains the optional parameters for the DiskPools.BeginDeallocate method.

type DiskPoolsBeginDeleteOptions 

type DiskPoolsBeginDeleteOptions struct {
}

DiskPoolsBeginDeleteOptions contains the optional parameters for the DiskPools.BeginDelete method.

type DiskPoolsBeginStartOptions 

type DiskPoolsBeginStartOptions struct {
}

DiskPoolsBeginStartOptions contains the optional parameters for the DiskPools.BeginStart method.

type DiskPoolsBeginUpdateOptions 

type DiskPoolsBeginUpdateOptions struct {
}

DiskPoolsBeginUpdateOptions contains the optional parameters for the DiskPools.BeginUpdate method.

type DiskPoolsBeginUpgradeOptions 

type DiskPoolsBeginUpgradeOptions struct {
}

DiskPoolsBeginUpgradeOptions contains the optional parameters for the DiskPools.BeginUpgrade method.

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.

func (*DiskPoolsClient) BeginCreateOrUpdate 

func (client *DiskPoolsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, diskPoolName string, diskPoolCreatePayload DiskPoolCreate, options *DiskPoolsBeginCreateOrUpdateOptions) (DiskPoolsCreateOrUpdatePollerResponse, 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 the *Error error type.

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("DiskPool.ID: %s\n", *res.ID)
}

Output:

func (*DiskPoolsClient) BeginDeallocate 

func (client *DiskPoolsClient) BeginDeallocate(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsBeginDeallocateOptions) (DiskPoolsDeallocatePollerResponse, 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 the *Error error type.

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 *DiskPoolsBeginDeleteOptions) (DiskPoolsDeletePollerResponse, 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 the *Error error type.

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 *DiskPoolsBeginStartOptions) (DiskPoolsStartPollerResponse, 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 the *Error error type.

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 *DiskPoolsBeginUpdateOptions) (DiskPoolsUpdatePollerResponse, error)

BeginUpdate - Update a Disk pool. If the operation fails it returns the *Error error type.

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("DiskPool.ID: %s\n", *res.ID)
}

Output:

func (*DiskPoolsClient) BeginUpgrade 

func (client *DiskPoolsClient) BeginUpgrade(ctx context.Context, resourceGroupName string, diskPoolName string, options *DiskPoolsBeginUpgradeOptions) (DiskPoolsUpgradePollerResponse, 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 the *Error error type.

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 *DiskPoolsGetOptions) (DiskPoolsGetResponse, error)

Get - Get a Disk pool. If the operation fails it returns the *Error error type.

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("DiskPool.ID: %s\n", *res.ID)
}

Output:

func (*DiskPoolsClient) ListByResourceGroup 

func (client *DiskPoolsClient) ListByResourceGroup(resourceGroupName string, options *DiskPoolsListByResourceGroupOptions) *DiskPoolsListByResourceGroupPager

ListByResourceGroup - Gets a list of DiskPools in a resource group. If the operation fails it returns the *Error error type.

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 pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("DiskPool.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*DiskPoolsClient) ListBySubscription 

func (client *DiskPoolsClient) ListBySubscription(options *DiskPoolsListBySubscriptionOptions) *DiskPoolsListBySubscriptionPager

ListBySubscription - Gets a list of Disk Pools in a subscription If the operation fails it returns the *Error error type.

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 pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("DiskPool.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*DiskPoolsClient) ListOutboundNetworkDependenciesEndpoints 

func (client *DiskPoolsClient) ListOutboundNetworkDependenciesEndpoints(resourceGroupName string, diskPoolName string, options *DiskPoolsListOutboundNetworkDependenciesEndpointsOptions) *DiskPoolsListOutboundNetworkDependenciesEndpointsPager

ListOutboundNetworkDependenciesEndpoints - Gets the network endpoints of all outbound dependencies of a Disk Pool If the operation fails it returns the *Error error type.

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 pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

type DiskPoolsCreateOrUpdatePoller 

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

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

func (*DiskPoolsCreateOrUpdatePoller) Done 

func (p *DiskPoolsCreateOrUpdatePoller) Done() bool

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

func (*DiskPoolsCreateOrUpdatePoller) FinalResponse 

func (p *DiskPoolsCreateOrUpdatePoller) FinalResponse(ctx context.Context) (DiskPoolsCreateOrUpdateResponse, error)

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 DiskPoolsCreateOrUpdateResponse will be returned.

func (*DiskPoolsCreateOrUpdatePoller) Poll 

func (p *DiskPoolsCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*DiskPoolsCreateOrUpdatePoller) ResumeToken 

func (p *DiskPoolsCreateOrUpdatePoller) 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 DiskPoolsCreateOrUpdatePollerResponse 

type DiskPoolsCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsCreateOrUpdatePoller

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

DiskPoolsCreateOrUpdatePollerResponse contains the response from method DiskPools.CreateOrUpdate.

func (DiskPoolsCreateOrUpdatePollerResponse) PollUntilDone 

func (l DiskPoolsCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DiskPoolsCreateOrUpdateResponse, error)

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 (*DiskPoolsCreateOrUpdatePollerResponse) Resume 

func (l *DiskPoolsCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *DiskPoolsClient, token string) error

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

type DiskPoolsCreateOrUpdateResponse 

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

DiskPoolsCreateOrUpdateResponse contains the response from method DiskPools.CreateOrUpdate.

type DiskPoolsCreateOrUpdateResult 

type DiskPoolsCreateOrUpdateResult struct {
	DiskPool
}

DiskPoolsCreateOrUpdateResult contains the result from method DiskPools.CreateOrUpdate.

type DiskPoolsDeallocatePoller 

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

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

func (*DiskPoolsDeallocatePoller) Done 

func (p *DiskPoolsDeallocatePoller) Done() bool

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

func (*DiskPoolsDeallocatePoller) FinalResponse 

func (p *DiskPoolsDeallocatePoller) FinalResponse(ctx context.Context) (DiskPoolsDeallocateResponse, error)

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 DiskPoolsDeallocateResponse will be returned.

func (*DiskPoolsDeallocatePoller) Poll 

func (p *DiskPoolsDeallocatePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*DiskPoolsDeallocatePoller) ResumeToken 

func (p *DiskPoolsDeallocatePoller) 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 DiskPoolsDeallocatePollerResponse 

type DiskPoolsDeallocatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsDeallocatePoller

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

DiskPoolsDeallocatePollerResponse contains the response from method DiskPools.Deallocate.

func (DiskPoolsDeallocatePollerResponse) PollUntilDone 

func (l DiskPoolsDeallocatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DiskPoolsDeallocateResponse, error)

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 (*DiskPoolsDeallocatePollerResponse) Resume 

func (l *DiskPoolsDeallocatePollerResponse) Resume(ctx context.Context, client *DiskPoolsClient, token string) error

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

type DiskPoolsDeallocateResponse 

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

DiskPoolsDeallocateResponse contains the response from method DiskPools.Deallocate.

type DiskPoolsDeletePoller 

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

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

func (*DiskPoolsDeletePoller) Done 

func (p *DiskPoolsDeletePoller) Done() bool

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

func (*DiskPoolsDeletePoller) FinalResponse 

func (p *DiskPoolsDeletePoller) FinalResponse(ctx context.Context) (DiskPoolsDeleteResponse, error)

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 DiskPoolsDeleteResponse will be returned.

func (*DiskPoolsDeletePoller) Poll 

func (p *DiskPoolsDeletePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*DiskPoolsDeletePoller) ResumeToken 

func (p *DiskPoolsDeletePoller) 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 DiskPoolsDeletePollerResponse 

type DiskPoolsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsDeletePoller

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

DiskPoolsDeletePollerResponse contains the response from method DiskPools.Delete.

func (DiskPoolsDeletePollerResponse) PollUntilDone 

func (l DiskPoolsDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DiskPoolsDeleteResponse, error)

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 (*DiskPoolsDeletePollerResponse) Resume 

func (l *DiskPoolsDeletePollerResponse) Resume(ctx context.Context, client *DiskPoolsClient, token string) error

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

type DiskPoolsDeleteResponse 

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

DiskPoolsDeleteResponse contains the response from method DiskPools.Delete.

type DiskPoolsGetOptions 

type DiskPoolsGetOptions struct {
}

DiskPoolsGetOptions contains the optional parameters for the DiskPools.Get method.

type DiskPoolsGetResponse 

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

DiskPoolsGetResponse contains the response from method DiskPools.Get.

type DiskPoolsGetResult 

type DiskPoolsGetResult struct {
	DiskPool
}

DiskPoolsGetResult contains the result from method DiskPools.Get.

type DiskPoolsListByResourceGroupOptions 

type DiskPoolsListByResourceGroupOptions struct {
}

DiskPoolsListByResourceGroupOptions contains the optional parameters for the DiskPools.ListByResourceGroup method.

type DiskPoolsListByResourceGroupPager 

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

DiskPoolsListByResourceGroupPager provides operations for iterating over paged responses.

func (*DiskPoolsListByResourceGroupPager) Err 

func (p *DiskPoolsListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*DiskPoolsListByResourceGroupPager) NextPage 

func (p *DiskPoolsListByResourceGroupPager) NextPage(ctx context.Context) bool

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

func (*DiskPoolsListByResourceGroupPager) PageResponse 

func (p *DiskPoolsListByResourceGroupPager) PageResponse() DiskPoolsListByResourceGroupResponse

PageResponse returns the current DiskPoolsListByResourceGroupResponse page.

type DiskPoolsListByResourceGroupResponse 

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

DiskPoolsListByResourceGroupResponse contains the response from method DiskPools.ListByResourceGroup.

type DiskPoolsListByResourceGroupResult 

type DiskPoolsListByResourceGroupResult struct {
	DiskPoolListResult
}

DiskPoolsListByResourceGroupResult contains the result from method DiskPools.ListByResourceGroup.

type DiskPoolsListBySubscriptionOptions 

type DiskPoolsListBySubscriptionOptions struct {
}

DiskPoolsListBySubscriptionOptions contains the optional parameters for the DiskPools.ListBySubscription method.

type DiskPoolsListBySubscriptionPager 

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

DiskPoolsListBySubscriptionPager provides operations for iterating over paged responses.

func (*DiskPoolsListBySubscriptionPager) Err 

func (p *DiskPoolsListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*DiskPoolsListBySubscriptionPager) NextPage 

func (p *DiskPoolsListBySubscriptionPager) NextPage(ctx context.Context) bool

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

func (*DiskPoolsListBySubscriptionPager) PageResponse 

func (p *DiskPoolsListBySubscriptionPager) PageResponse() DiskPoolsListBySubscriptionResponse

PageResponse returns the current DiskPoolsListBySubscriptionResponse page.

type DiskPoolsListBySubscriptionResponse 

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

DiskPoolsListBySubscriptionResponse contains the response from method DiskPools.ListBySubscription.

type DiskPoolsListBySubscriptionResult 

type DiskPoolsListBySubscriptionResult struct {
	DiskPoolListResult
}

DiskPoolsListBySubscriptionResult contains the result from method DiskPools.ListBySubscription.

type DiskPoolsListOutboundNetworkDependenciesEndpointsOptions 

type DiskPoolsListOutboundNetworkDependenciesEndpointsOptions struct {
}

DiskPoolsListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the DiskPools.ListOutboundNetworkDependenciesEndpoints method.

type DiskPoolsListOutboundNetworkDependenciesEndpointsPager 

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

DiskPoolsListOutboundNetworkDependenciesEndpointsPager provides operations for iterating over paged responses.

func (*DiskPoolsListOutboundNetworkDependenciesEndpointsPager) Err 

func (p *DiskPoolsListOutboundNetworkDependenciesEndpointsPager) Err() error

Err returns the last error encountered while paging.

func (*DiskPoolsListOutboundNetworkDependenciesEndpointsPager) NextPage 

func (p *DiskPoolsListOutboundNetworkDependenciesEndpointsPager) NextPage(ctx context.Context) bool

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

func (*DiskPoolsListOutboundNetworkDependenciesEndpointsPager) PageResponse 

func (p *DiskPoolsListOutboundNetworkDependenciesEndpointsPager) PageResponse() DiskPoolsListOutboundNetworkDependenciesEndpointsResponse

PageResponse returns the current DiskPoolsListOutboundNetworkDependenciesEndpointsResponse page.

type DiskPoolsListOutboundNetworkDependenciesEndpointsResponse 

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

DiskPoolsListOutboundNetworkDependenciesEndpointsResponse contains the response from method DiskPools.ListOutboundNetworkDependenciesEndpoints.

type DiskPoolsListOutboundNetworkDependenciesEndpointsResult 

type DiskPoolsListOutboundNetworkDependenciesEndpointsResult struct {
	OutboundEnvironmentEndpointList
}

DiskPoolsListOutboundNetworkDependenciesEndpointsResult contains the result from method DiskPools.ListOutboundNetworkDependenciesEndpoints.

type DiskPoolsStartPoller 

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

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

func (*DiskPoolsStartPoller) Done 

func (p *DiskPoolsStartPoller) Done() bool

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

func (*DiskPoolsStartPoller) FinalResponse 

func (p *DiskPoolsStartPoller) FinalResponse(ctx context.Context) (DiskPoolsStartResponse, error)

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 DiskPoolsStartResponse will be returned.

func (*DiskPoolsStartPoller) Poll 

func (p *DiskPoolsStartPoller) Poll(ctx context.Context) (*http.Response, error)

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 (*DiskPoolsStartPoller) ResumeToken 

func (p *DiskPoolsStartPoller) 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 DiskPoolsStartPollerResponse 

type DiskPoolsStartPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsStartPoller

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

DiskPoolsStartPollerResponse contains the response from method DiskPools.Start.

func (DiskPoolsStartPollerResponse) PollUntilDone 

func (l DiskPoolsStartPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DiskPoolsStartResponse, error)

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 (*DiskPoolsStartPollerResponse) Resume 

func (l *DiskPoolsStartPollerResponse) Resume(ctx context.Context, client *DiskPoolsClient, token string) error

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

type DiskPoolsStartResponse 

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

DiskPoolsStartResponse contains the response from method DiskPools.Start.

type DiskPoolsUpdatePoller 

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

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

func (*DiskPoolsUpdatePoller) Done 

func (p *DiskPoolsUpdatePoller) Done() bool

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

func (*DiskPoolsUpdatePoller) FinalResponse 

func (p *DiskPoolsUpdatePoller) FinalResponse(ctx context.Context) (DiskPoolsUpdateResponse, error)

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 DiskPoolsUpdateResponse will be returned.

func (*DiskPoolsUpdatePoller) Poll 

func (p *DiskPoolsUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*DiskPoolsUpdatePoller) ResumeToken 

func (p *DiskPoolsUpdatePoller) 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 DiskPoolsUpdatePollerResponse 

type DiskPoolsUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsUpdatePoller

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

DiskPoolsUpdatePollerResponse contains the response from method DiskPools.Update.

func (DiskPoolsUpdatePollerResponse) PollUntilDone 

func (l DiskPoolsUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DiskPoolsUpdateResponse, error)

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 (*DiskPoolsUpdatePollerResponse) Resume 

func (l *DiskPoolsUpdatePollerResponse) Resume(ctx context.Context, client *DiskPoolsClient, token string) error

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

type DiskPoolsUpdateResponse 

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

DiskPoolsUpdateResponse contains the response from method DiskPools.Update.

type DiskPoolsUpdateResult 

type DiskPoolsUpdateResult struct {
	DiskPool
}

DiskPoolsUpdateResult contains the result from method DiskPools.Update.

type DiskPoolsUpgradePoller 

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

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

func (*DiskPoolsUpgradePoller) Done 

func (p *DiskPoolsUpgradePoller) Done() bool

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

func (*DiskPoolsUpgradePoller) FinalResponse 

func (p *DiskPoolsUpgradePoller) FinalResponse(ctx context.Context) (DiskPoolsUpgradeResponse, error)

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 DiskPoolsUpgradeResponse will be returned.

func (*DiskPoolsUpgradePoller) Poll 

func (p *DiskPoolsUpgradePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*DiskPoolsUpgradePoller) ResumeToken 

func (p *DiskPoolsUpgradePoller) 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 DiskPoolsUpgradePollerResponse 

type DiskPoolsUpgradePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DiskPoolsUpgradePoller

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

DiskPoolsUpgradePollerResponse contains the response from method DiskPools.Upgrade.

func (DiskPoolsUpgradePollerResponse) PollUntilDone 

func (l DiskPoolsUpgradePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DiskPoolsUpgradeResponse, error)

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 (*DiskPoolsUpgradePollerResponse) Resume 

func (l *DiskPoolsUpgradePollerResponse) Resume(ctx context.Context, client *DiskPoolsClient, token string) error

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

type DiskPoolsUpgradeResponse 

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

DiskPoolsUpgradeResponse contains the response from method DiskPools.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.
	InnerError *ErrorResponse `json:"error,omitempty"`
	// contains filtered or unexported fields
}

Error - The resource management error response. Implements the error and azcore.HTTPResponse interfaces.

func (Error) Error 

func (e Error) Error() string

Error implements the error interface for type Error. The contents of the error text are not contractual and subject to change.

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 {
	ProxyResource
	// REQUIRED; Properties for iSCSI Target operations.
	Properties *IscsiTargetProperties `json:"properties,omitempty"`

	// 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; Resource metadata required by ARM RPC
	SystemData *SystemMetadata `json:"systemData,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 

func (c IscsiTargetACLMode) ToPtr() *IscsiTargetACLMode

ToPtr returns a *IscsiTargetACLMode pointing to the current value.

type IscsiTargetCreate 

type IscsiTargetCreate struct {
	ProxyResource
	// 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"`
}

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 {
	ProxyResource
	// 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"`
}

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 IscsiTargetsBeginCreateOrUpdateOptions 

type IscsiTargetsBeginCreateOrUpdateOptions struct {
}

IscsiTargetsBeginCreateOrUpdateOptions contains the optional parameters for the IscsiTargets.BeginCreateOrUpdate method.

type IscsiTargetsBeginDeleteOptions 

type IscsiTargetsBeginDeleteOptions struct {
}

IscsiTargetsBeginDeleteOptions contains the optional parameters for the IscsiTargets.BeginDelete method.

type IscsiTargetsBeginUpdateOptions 

type IscsiTargetsBeginUpdateOptions struct {
}

IscsiTargetsBeginUpdateOptions contains the optional parameters for the IscsiTargets.BeginUpdate method.

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.

func (*IscsiTargetsClient) BeginCreateOrUpdate 

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

BeginCreateOrUpdate - Create or Update an iSCSI Target. If the operation fails it returns the *Error error type.

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.IscsiTargetACLModeDynamic.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("IscsiTarget.ID: %s\n", *res.ID)
}

Output:

func (*IscsiTargetsClient) BeginDelete 

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

BeginDelete - Delete an iSCSI Target. If the operation fails it returns the *Error error type.

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 *IscsiTargetsBeginUpdateOptions) (IscsiTargetsUpdatePollerResponse, error)

BeginUpdate - Update an iSCSI Target. If the operation fails it returns the *Error error type.

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("IscsiTarget.ID: %s\n", *res.ID)
}

Output:

func (*IscsiTargetsClient) Get 

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

Get - Get an iSCSI Target. If the operation fails it returns the *Error error type.

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("IscsiTarget.ID: %s\n", *res.ID)
}

Output:

func (*IscsiTargetsClient) ListByDiskPool 

func (client *IscsiTargetsClient) ListByDiskPool(resourceGroupName string, diskPoolName string, options *IscsiTargetsListByDiskPoolOptions) *IscsiTargetsListByDiskPoolPager

ListByDiskPool - Get iSCSI Targets in a Disk pool. If the operation fails it returns the *Error error type.

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 pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("IscsiTarget.ID: %s\n", *v.ID)
		}
	}
}

Output:

type IscsiTargetsCreateOrUpdatePoller 

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

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

func (*IscsiTargetsCreateOrUpdatePoller) Done 

func (p *IscsiTargetsCreateOrUpdatePoller) Done() bool

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

func (*IscsiTargetsCreateOrUpdatePoller) FinalResponse 

func (p *IscsiTargetsCreateOrUpdatePoller) FinalResponse(ctx context.Context) (IscsiTargetsCreateOrUpdateResponse, error)

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 IscsiTargetsCreateOrUpdateResponse will be returned.

func (*IscsiTargetsCreateOrUpdatePoller) Poll 

func (p *IscsiTargetsCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*IscsiTargetsCreateOrUpdatePoller) ResumeToken 

func (p *IscsiTargetsCreateOrUpdatePoller) 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 IscsiTargetsCreateOrUpdatePollerResponse 

type IscsiTargetsCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IscsiTargetsCreateOrUpdatePoller

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

IscsiTargetsCreateOrUpdatePollerResponse contains the response from method IscsiTargets.CreateOrUpdate.

func (IscsiTargetsCreateOrUpdatePollerResponse) PollUntilDone 

func (l IscsiTargetsCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IscsiTargetsCreateOrUpdateResponse, error)

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 (*IscsiTargetsCreateOrUpdatePollerResponse) Resume 

func (l *IscsiTargetsCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *IscsiTargetsClient, token string) error

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

type IscsiTargetsCreateOrUpdateResponse 

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

IscsiTargetsCreateOrUpdateResponse contains the response from method IscsiTargets.CreateOrUpdate.

type IscsiTargetsCreateOrUpdateResult 

type IscsiTargetsCreateOrUpdateResult struct {
	IscsiTarget
}

IscsiTargetsCreateOrUpdateResult contains the result from method IscsiTargets.CreateOrUpdate.

type IscsiTargetsDeletePoller 

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

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

func (*IscsiTargetsDeletePoller) Done 

func (p *IscsiTargetsDeletePoller) Done() bool

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

func (*IscsiTargetsDeletePoller) FinalResponse 

func (p *IscsiTargetsDeletePoller) FinalResponse(ctx context.Context) (IscsiTargetsDeleteResponse, error)

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 IscsiTargetsDeleteResponse will be returned.

func (*IscsiTargetsDeletePoller) Poll 

func (p *IscsiTargetsDeletePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*IscsiTargetsDeletePoller) ResumeToken 

func (p *IscsiTargetsDeletePoller) 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 IscsiTargetsDeletePollerResponse 

type IscsiTargetsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IscsiTargetsDeletePoller

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

IscsiTargetsDeletePollerResponse contains the response from method IscsiTargets.Delete.

func (IscsiTargetsDeletePollerResponse) PollUntilDone 

func (l IscsiTargetsDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IscsiTargetsDeleteResponse, error)

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 (*IscsiTargetsDeletePollerResponse) Resume 

func (l *IscsiTargetsDeletePollerResponse) Resume(ctx context.Context, client *IscsiTargetsClient, token string) error

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

type IscsiTargetsDeleteResponse 

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

IscsiTargetsDeleteResponse contains the response from method IscsiTargets.Delete.

type IscsiTargetsGetOptions 

type IscsiTargetsGetOptions struct {
}

IscsiTargetsGetOptions contains the optional parameters for the IscsiTargets.Get method.

type IscsiTargetsGetResponse 

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

IscsiTargetsGetResponse contains the response from method IscsiTargets.Get.

type IscsiTargetsGetResult 

type IscsiTargetsGetResult struct {
	IscsiTarget
}

IscsiTargetsGetResult contains the result from method IscsiTargets.Get.

type IscsiTargetsListByDiskPoolOptions 

type IscsiTargetsListByDiskPoolOptions struct {
}

IscsiTargetsListByDiskPoolOptions contains the optional parameters for the IscsiTargets.ListByDiskPool method.

type IscsiTargetsListByDiskPoolPager 

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

IscsiTargetsListByDiskPoolPager provides operations for iterating over paged responses.

func (*IscsiTargetsListByDiskPoolPager) Err 

func (p *IscsiTargetsListByDiskPoolPager) Err() error

Err returns the last error encountered while paging.

func (*IscsiTargetsListByDiskPoolPager) NextPage 

func (p *IscsiTargetsListByDiskPoolPager) NextPage(ctx context.Context) bool

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

func (*IscsiTargetsListByDiskPoolPager) PageResponse 

func (p *IscsiTargetsListByDiskPoolPager) PageResponse() IscsiTargetsListByDiskPoolResponse

PageResponse returns the current IscsiTargetsListByDiskPoolResponse page.

type IscsiTargetsListByDiskPoolResponse 

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

IscsiTargetsListByDiskPoolResponse contains the response from method IscsiTargets.ListByDiskPool.

type IscsiTargetsListByDiskPoolResult 

type IscsiTargetsListByDiskPoolResult struct {
	IscsiTargetList
}

IscsiTargetsListByDiskPoolResult contains the result from method IscsiTargets.ListByDiskPool.

type IscsiTargetsUpdatePoller 

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

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

func (*IscsiTargetsUpdatePoller) Done 

func (p *IscsiTargetsUpdatePoller) Done() bool

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

func (*IscsiTargetsUpdatePoller) FinalResponse 

func (p *IscsiTargetsUpdatePoller) FinalResponse(ctx context.Context) (IscsiTargetsUpdateResponse, error)

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 IscsiTargetsUpdateResponse will be returned.

func (*IscsiTargetsUpdatePoller) Poll 

func (p *IscsiTargetsUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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 (*IscsiTargetsUpdatePoller) ResumeToken 

func (p *IscsiTargetsUpdatePoller) 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 IscsiTargetsUpdatePollerResponse 

type IscsiTargetsUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IscsiTargetsUpdatePoller

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

IscsiTargetsUpdatePollerResponse contains the response from method IscsiTargets.Update.

func (IscsiTargetsUpdatePollerResponse) PollUntilDone 

func (l IscsiTargetsUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IscsiTargetsUpdateResponse, error)

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 (*IscsiTargetsUpdatePollerResponse) Resume 

func (l *IscsiTargetsUpdatePollerResponse) Resume(ctx context.Context, client *IscsiTargetsClient, token string) error

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

type IscsiTargetsUpdateResponse 

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

IscsiTargetsUpdateResponse contains the response from method IscsiTargets.Update.

type IscsiTargetsUpdateResult 

type IscsiTargetsUpdateResult struct {
	IscsiTarget
}

IscsiTargetsUpdateResult contains the result from method IscsiTargets.Update.

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 

func (c OperationalStatus) ToPtr() *OperationalStatus

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.

func (*OperationsClient) List 

func (client *OperationsClient) List(ctx context.Context, options *OperationsListOptions) (OperationsListResponse, error)

List - Gets a list of StoragePool operations. If the operation fails it returns the *Error error type.

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)
	_, err = client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type OperationsListOptions 

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListResponse 

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

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult 

type OperationsListResult struct {
	StoragePoolOperationListResult
}

OperationsListResult contains the result from method Operations.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 

func (c ProvisioningStates) ToPtr() *ProvisioningStates

ToPtr returns a *ProvisioningStates pointing to the current value.

type ProxyResource 

type ProxyResource struct {
	Resource
}

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

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.

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

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 

func (c ResourceSKURestrictionsReasonCode) ToPtr() *ResourceSKURestrictionsReasonCode

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 

func (c ResourceSKURestrictionsType) ToPtr() *ResourceSKURestrictionsType

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.

func (*ResourceSKUsClient) List 

func (client *ResourceSKUsClient) List(location string, options *ResourceSKUsListOptions) *ResourceSKUsListPager

List - Lists available StoragePool resources and skus in an Azure location. If the operation fails it returns the *Error error type.

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 pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}

Output:

type ResourceSKUsListOptions 

type ResourceSKUsListOptions struct {
}

ResourceSKUsListOptions contains the optional parameters for the ResourceSKUs.List method.

type ResourceSKUsListPager 

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

ResourceSKUsListPager provides operations for iterating over paged responses.

func (*ResourceSKUsListPager) Err 

func (p *ResourceSKUsListPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceSKUsListPager) NextPage 

func (p *ResourceSKUsListPager) NextPage(ctx context.Context) bool

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

func (*ResourceSKUsListPager) PageResponse 

func (p *ResourceSKUsListPager) PageResponse() ResourceSKUsListResponse

PageResponse returns the current ResourceSKUsListResponse page.

type ResourceSKUsListResponse 

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

ResourceSKUsListResponse contains the response from method ResourceSKUs.List.

type ResourceSKUsListResult 

type ResourceSKUsListResult struct {
	ResourceSKUListResult
}

ResourceSKUsListResult contains the result from method ResourceSKUs.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 StoragePoolOperationDisplay 

type StoragePoolOperationDisplay 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"`
}

StoragePoolOperationDisplay - Metadata about an operation.

type StoragePoolOperationListResult 

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

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

StoragePoolOperationListResult - List of operations supported by the RP.

func (StoragePoolOperationListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type StoragePoolOperationListResult.

type StoragePoolRPOperation 

type StoragePoolRPOperation struct {
	// REQUIRED; Additional metadata about RP operation.
	Display *StoragePoolOperationDisplay `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"`
}

StoragePoolRPOperation - Description of a StoragePool RP Operation

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 {
	Resource
	// REQUIRED; The geo-location where the resource lives.
	Location *string `json:"location,omitempty"`

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

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.