armwindowsiot

package module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Dec 22, 2021 License: MIT Imports: 15 Imported by: 3

README

Azure Windows IoT Module for Go

PkgGoDev

The armwindowsiot module provides operations for working with Azure Windows IoT.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Windows IoT module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/windowsiot/armwindowsiot

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Windows IoT. 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 Windows IoT 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 := armwindowsiot.NewServicesClient(<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 := armwindowsiot.NewServicesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Windows IoT 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 DeviceService

type DeviceService struct {
	TrackedResource
	// The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
	Etag *string `json:"etag,omitempty"`

	// The properties of a Windows IoT Device Service.
	Properties *DeviceServiceProperties `json:"properties,omitempty"`
}

DeviceService - The description of the Windows IoT Device Service.

func (DeviceService) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DeviceService.

type DeviceServiceCheckNameAvailabilityParameters

type DeviceServiceCheckNameAvailabilityParameters struct {
	// REQUIRED; The name of the Windows IoT Device Service to check.
	Name *string `json:"name,omitempty"`
}

DeviceServiceCheckNameAvailabilityParameters - Input values.

type DeviceServiceDescriptionListResult

type DeviceServiceDescriptionListResult struct {
	// The array of DeviceService objects.
	Value []*DeviceService `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DeviceServiceDescriptionListResult - The JSON-serialized array of DeviceService objects with a next link.

func (DeviceServiceDescriptionListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DeviceServiceDescriptionListResult.

type DeviceServiceNameAvailabilityInfo

type DeviceServiceNameAvailabilityInfo struct {
	// The detailed reason message.
	Message *string `json:"message,omitempty"`

	// READ-ONLY; The value which indicates whether the provided name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty" azure:"ro"`

	// READ-ONLY; The reason for unavailability.
	Reason *ServiceNameUnavailabilityReason `json:"reason,omitempty" azure:"ro"`
}

DeviceServiceNameAvailabilityInfo - The properties indicating whether a given Windows IoT Device Service name is available.

type DeviceServiceProperties

type DeviceServiceProperties struct {
	// Windows IoT Device Service OEM AAD domain
	AdminDomainName *string `json:"adminDomainName,omitempty"`

	// Windows IoT Device Service ODM AAD domain
	BillingDomainName *string `json:"billingDomainName,omitempty"`

	// Windows IoT Device Service notes.
	Notes *string `json:"notes,omitempty"`

	// Windows IoT Device Service device allocation,
	Quantity *int64 `json:"quantity,omitempty"`

	// READ-ONLY; Windows IoT Device Service start date,
	StartDate *time.Time `json:"startDate,omitempty" azure:"ro"`
}

DeviceServiceProperties - The properties of a Windows IoT Device Service.

func (DeviceServiceProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DeviceServiceProperties.

func (*DeviceServiceProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceServiceProperties.

type ErrorDetails

type ErrorDetails struct {

	// The error object.
	InnerError *ErrorDetailsError `json:"error,omitempty"`
	// contains filtered or unexported fields
}

ErrorDetails - The details of the error. Implements the error and azcore.HTTPResponse interfaces.

func (ErrorDetails) Error

func (e ErrorDetails) Error() string

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

type ErrorDetailsError

type ErrorDetailsError struct {
	// One of a server-defined set of error codes.
	Code *string `json:"code,omitempty"`

	// A human-readable representation of the error's details.
	Details *string `json:"details,omitempty"`

	// A human-readable representation of the error.
	Message *string `json:"message,omitempty"`

	// The target of the particular error.
	Target *string `json:"target,omitempty"`
}

ErrorDetailsError - The error object.

type OperationDisplayInfo

type OperationDisplayInfo struct {
	// The description of the operation.
	Description *string `json:"description,omitempty"`

	// The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Azure Data Catalog Service.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo - The operation supported by Azure Data Catalog Service.

type OperationEntity

type OperationEntity struct {
	// The operation supported by Azure Data Catalog Service.
	Display *OperationDisplayInfo `json:"display,omitempty"`

	// Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`

	// Indicates the executor of the operation.
	Origin *string `json:"origin,omitempty"`
}

OperationEntity - The operation supported by Azure Data Catalog Service.

type OperationListResult

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of Windows IoT Device Service operations supported by the Microsoft.WindowsIoT resource provider.
	Value []*OperationEntity `json:"value,omitempty" azure:"ro"`
}

OperationListResult - Result of the request to list Windows IoT Device Service operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

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

List - Lists all of the available Windows IoT Services REST API operations. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/OperationsList.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/windowsiot/armwindowsiot"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
	}
}
Output:

type OperationsListOptions

type OperationsListOptions struct {
}

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

type OperationsListPager

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage

func (p *OperationsListPager) 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 (*OperationsListPager) PageResponse

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

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 {
	OperationListResult
}

OperationsListResult contains the result from method Operations.List.

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
	ID *string `json:"id,omitempty" azure:"ro"`

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

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

Resource - The core properties of ARM resources

func (Resource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type ServiceNameUnavailabilityReason

type ServiceNameUnavailabilityReason string

ServiceNameUnavailabilityReason - The reason for unavailability.

const (
	ServiceNameUnavailabilityReasonInvalid       ServiceNameUnavailabilityReason = "Invalid"
	ServiceNameUnavailabilityReasonAlreadyExists ServiceNameUnavailabilityReason = "AlreadyExists"
)

func PossibleServiceNameUnavailabilityReasonValues

func PossibleServiceNameUnavailabilityReasonValues() []ServiceNameUnavailabilityReason

PossibleServiceNameUnavailabilityReasonValues returns the possible values for the ServiceNameUnavailabilityReason const type.

func (ServiceNameUnavailabilityReason) ToPtr

ToPtr returns a *ServiceNameUnavailabilityReason pointing to the current value.

type ServicesCheckDeviceServiceNameAvailabilityOptions

type ServicesCheckDeviceServiceNameAvailabilityOptions struct {
}

ServicesCheckDeviceServiceNameAvailabilityOptions contains the optional parameters for the Services.CheckDeviceServiceNameAvailability method.

type ServicesCheckDeviceServiceNameAvailabilityResponse

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

ServicesCheckDeviceServiceNameAvailabilityResponse contains the response from method Services.CheckDeviceServiceNameAvailability.

type ServicesCheckDeviceServiceNameAvailabilityResult

type ServicesCheckDeviceServiceNameAvailabilityResult struct {
	DeviceServiceNameAvailabilityInfo
}

ServicesCheckDeviceServiceNameAvailabilityResult contains the result from method Services.CheckDeviceServiceNameAvailability.

type ServicesClient

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

ServicesClient contains the methods for the Services group. Don't use this type directly, use NewServicesClient() instead.

func NewServicesClient

func NewServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServicesClient

NewServicesClient creates a new instance of ServicesClient with the specified values.

func (*ServicesClient) CheckDeviceServiceNameAvailability

func (client *ServicesClient) CheckDeviceServiceNameAvailability(ctx context.Context, deviceServiceCheckNameAvailabilityParameters DeviceServiceCheckNameAvailabilityParameters, options *ServicesCheckDeviceServiceNameAvailabilityOptions) (ServicesCheckDeviceServiceNameAvailabilityResponse, error)

CheckDeviceServiceNameAvailability - Check if a Windows IoT Device Service name is available. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_CheckNameAvailability.json

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<subscription-id>", cred, nil)
	_, err = client.CheckDeviceServiceNameAvailability(ctx,
		armwindowsiot.DeviceServiceCheckNameAvailabilityParameters{
			Name: to.StringPtr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}
Output:

func (*ServicesClient) CreateOrUpdate

func (client *ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, deviceName string, deviceService DeviceService, options *ServicesCreateOrUpdateOptions) (ServicesCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_Create.json

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<device-name>",
		armwindowsiot.DeviceService{
			TrackedResource: armwindowsiot.TrackedResource{
				Location: to.StringPtr("<location>"),
			},
			Properties: &armwindowsiot.DeviceServiceProperties{
				AdminDomainName:   to.StringPtr("<admin-domain-name>"),
				BillingDomainName: to.StringPtr("<billing-domain-name>"),
				Notes:             to.StringPtr("<notes>"),
				Quantity:          to.Int64Ptr(1000000),
			},
		},
		&armwindowsiot.ServicesCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceService.ID: %s\n", *res.ID)
}
Output:

func (*ServicesClient) Delete

func (client *ServicesClient) Delete(ctx context.Context, resourceGroupName string, deviceName string, options *ServicesDeleteOptions) (ServicesDeleteResponse, error)

Delete - Delete a Windows IoT Device Service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_Delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/windowsiot/armwindowsiot"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.Delete(ctx,
		"<resource-group-name>",
		"<device-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceService.ID: %s\n", *res.ID)
}
Output:

func (*ServicesClient) Get

func (client *ServicesClient) Get(ctx context.Context, resourceGroupName string, deviceName string, options *ServicesGetOptions) (ServicesGetResponse, error)

Get - Get the non-security related metadata of a Windows IoT Device Service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_GetProperties.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/windowsiot/armwindowsiot"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<device-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceService.ID: %s\n", *res.ID)
}
Output:

func (*ServicesClient) List

func (client *ServicesClient) List(options *ServicesListOptions) *ServicesListPager

List - Get all the IoT hubs in a subscription. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_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/windowsiot/armwindowsiot"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<subscription-id>", cred, nil)
	pager := client.List(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("DeviceService.ID: %s\n", *v.ID)
		}
	}
}
Output:

func (*ServicesClient) ListByResourceGroup

func (client *ServicesClient) ListByResourceGroup(resourceGroupName string, options *ServicesListByResourceGroupOptions) *ServicesListByResourceGroupPager

ListByResourceGroup - Get all the IoT hubs in a resource group. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_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/windowsiot/armwindowsiot"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<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("DeviceService.ID: %s\n", *v.ID)
		}
	}
}
Output:

func (*ServicesClient) Update

func (client *ServicesClient) Update(ctx context.Context, resourceGroupName string, deviceName string, deviceService DeviceService, options *ServicesUpdateOptions) (ServicesUpdateResponse, error)

Update - Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service. If the operation fails it returns the *ErrorDetails error type.

Example

x-ms-original-file: specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/Service_Update.json

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armwindowsiot.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<device-name>",
		armwindowsiot.DeviceService{
			TrackedResource: armwindowsiot.TrackedResource{
				Location: to.StringPtr("<location>"),
			},
			Properties: &armwindowsiot.DeviceServiceProperties{
				AdminDomainName:   to.StringPtr("<admin-domain-name>"),
				BillingDomainName: to.StringPtr("<billing-domain-name>"),
				Notes:             to.StringPtr("<notes>"),
				Quantity:          to.Int64Ptr(1000000),
			},
		},
		&armwindowsiot.ServicesUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("DeviceService.ID: %s\n", *res.ID)
}
Output:

type ServicesCreateOrUpdateOptions

type ServicesCreateOrUpdateOptions struct {
	// ETag of the Windows IoT Device Service. Do not specify for creating a new Windows IoT Device Service. Required to update an existing Windows IoT Device
	// Service.
	IfMatch *string
}

ServicesCreateOrUpdateOptions contains the optional parameters for the Services.CreateOrUpdate method.

type ServicesCreateOrUpdateResponse

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

ServicesCreateOrUpdateResponse contains the response from method Services.CreateOrUpdate.

type ServicesCreateOrUpdateResult

type ServicesCreateOrUpdateResult struct {
	DeviceService
}

ServicesCreateOrUpdateResult contains the result from method Services.CreateOrUpdate.

type ServicesDeleteOptions

type ServicesDeleteOptions struct {
}

ServicesDeleteOptions contains the optional parameters for the Services.Delete method.

type ServicesDeleteResponse

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

ServicesDeleteResponse contains the response from method Services.Delete.

type ServicesDeleteResult

type ServicesDeleteResult struct {
	DeviceService
}

ServicesDeleteResult contains the result from method Services.Delete.

type ServicesGetOptions

type ServicesGetOptions struct {
}

ServicesGetOptions contains the optional parameters for the Services.Get method.

type ServicesGetResponse

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

ServicesGetResponse contains the response from method Services.Get.

type ServicesGetResult

type ServicesGetResult struct {
	DeviceService
}

ServicesGetResult contains the result from method Services.Get.

type ServicesListByResourceGroupOptions

type ServicesListByResourceGroupOptions struct {
}

ServicesListByResourceGroupOptions contains the optional parameters for the Services.ListByResourceGroup method.

type ServicesListByResourceGroupPager

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

ServicesListByResourceGroupPager provides operations for iterating over paged responses.

func (*ServicesListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*ServicesListByResourceGroupPager) NextPage

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

func (*ServicesListByResourceGroupPager) PageResponse

PageResponse returns the current ServicesListByResourceGroupResponse page.

type ServicesListByResourceGroupResponse

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

ServicesListByResourceGroupResponse contains the response from method Services.ListByResourceGroup.

type ServicesListByResourceGroupResult

type ServicesListByResourceGroupResult struct {
	DeviceServiceDescriptionListResult
}

ServicesListByResourceGroupResult contains the result from method Services.ListByResourceGroup.

type ServicesListOptions

type ServicesListOptions struct {
}

ServicesListOptions contains the optional parameters for the Services.List method.

type ServicesListPager

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

ServicesListPager provides operations for iterating over paged responses.

func (*ServicesListPager) Err

func (p *ServicesListPager) Err() error

Err returns the last error encountered while paging.

func (*ServicesListPager) NextPage

func (p *ServicesListPager) 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 (*ServicesListPager) PageResponse

func (p *ServicesListPager) PageResponse() ServicesListResponse

PageResponse returns the current ServicesListResponse page.

type ServicesListResponse

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

ServicesListResponse contains the response from method Services.List.

type ServicesListResult

type ServicesListResult struct {
	DeviceServiceDescriptionListResult
}

ServicesListResult contains the result from method Services.List.

type ServicesUpdateOptions

type ServicesUpdateOptions struct {
	// ETag of the Windows IoT Device Service. Do not specify for creating a brand new Windows IoT Device Service. Required to update an existing Windows IoT
	// Device Service.
	IfMatch *string
}

ServicesUpdateOptions contains the optional parameters for the Services.Update method.

type ServicesUpdateResponse

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

ServicesUpdateResponse contains the response from method Services.Update.

type ServicesUpdateResult

type ServicesUpdateResult struct {
	DeviceService
}

ServicesUpdateResult contains the result from method Services.Update.

type TrackedResource

type TrackedResource struct {
	Resource
	// The Azure Region 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.

Jump to

Keyboard shortcuts

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