Documentation ¶
Overview ¶
Package windowsiot implements the Azure ARM Windowsiot service API version 2019-06-01.
Use this API to manage the Windows IoT device services in your Azure subscription.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type DeviceService
- type DeviceServiceCheckNameAvailabilityParameters
- type DeviceServiceDescriptionListResult
- type DeviceServiceDescriptionListResultIterator
- func (iter *DeviceServiceDescriptionListResultIterator) Next() error
- func (iter *DeviceServiceDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter DeviceServiceDescriptionListResultIterator) NotDone() bool
- func (iter DeviceServiceDescriptionListResultIterator) Response() DeviceServiceDescriptionListResult
- func (iter DeviceServiceDescriptionListResultIterator) Value() DeviceService
- type DeviceServiceDescriptionListResultPage
- func (page *DeviceServiceDescriptionListResultPage) Next() error
- func (page *DeviceServiceDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page DeviceServiceDescriptionListResultPage) NotDone() bool
- func (page DeviceServiceDescriptionListResultPage) Response() DeviceServiceDescriptionListResult
- func (page DeviceServiceDescriptionListResultPage) Values() []DeviceService
- type DeviceServiceNameAvailabilityInfo
- type DeviceServiceProperties
- type ErrorDetails
- type OperationDisplayInfo
- type OperationEntity
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() OperationEntity
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []OperationEntity
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ProxyResource
- type Resource
- type ServiceNameUnavailabilityReason
- type ServicesClient
- func (client ServicesClient) CheckDeviceServiceNameAvailability(ctx context.Context, ...) (result DeviceServiceNameAvailabilityInfo, err error)
- func (client ServicesClient) CheckDeviceServiceNameAvailabilityPreparer(ctx context.Context, ...) (*http.Request, error)
- func (client ServicesClient) CheckDeviceServiceNameAvailabilityResponder(resp *http.Response) (result DeviceServiceNameAvailabilityInfo, err error)
- func (client ServicesClient) CheckDeviceServiceNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, deviceName string, ...) (result DeviceService, err error)
- func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, deviceName string, ...) (*http.Request, error)
- func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result DeviceService, err error)
- func (client ServicesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, deviceName string) (result DeviceService, err error)
- func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, deviceName string) (*http.Request, error)
- func (client ServicesClient) DeleteResponder(resp *http.Response) (result DeviceService, err error)
- func (client ServicesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, deviceName string) (result DeviceService, err error)
- func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, deviceName string) (*http.Request, error)
- func (client ServicesClient) GetResponder(resp *http.Response) (result DeviceService, err error)
- func (client ServicesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) List(ctx context.Context) (result DeviceServiceDescriptionListResultPage, err error)
- func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DeviceServiceDescriptionListResultPage, err error)
- func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DeviceServiceDescriptionListResultIterator, err error)
- func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result DeviceServiceDescriptionListResult, err error)
- func (client ServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) ListComplete(ctx context.Context) (result DeviceServiceDescriptionListResultIterator, err error)
- func (client ServicesClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client ServicesClient) ListResponder(resp *http.Response) (result DeviceServiceDescriptionListResult, err error)
- func (client ServicesClient) ListSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, deviceName string, ...) (result DeviceService, err error)
- func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, deviceName string, ...) (*http.Request, error)
- func (client ServicesClient) UpdateResponder(resp *http.Response) (result DeviceService, err error)
- func (client ServicesClient) UpdateSender(req *http.Request) (*http.Response, error)
- type TrackedResource
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Windowsiot
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
BaseClient is the base client for Windowsiot.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type DeviceService ¶
type DeviceService struct { autorest.Response `json:"-"` // Etag - 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"` // DeviceServiceProperties - The properties of a Windows IoT Device Service. *DeviceServiceProperties `json:"properties,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` // Location - The Azure Region where the resource lives Location *string `json:"location,omitempty"` // ID - READ-ONLY; Fully qualified resource Id for the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. Type *string `json:"type,omitempty"` }
DeviceService the description of the Windows IoT Device Service.
func (DeviceService) MarshalJSON ¶
func (ds DeviceService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceService.
func (*DeviceService) UnmarshalJSON ¶
func (ds *DeviceService) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DeviceService struct.
type DeviceServiceCheckNameAvailabilityParameters ¶
type DeviceServiceCheckNameAvailabilityParameters struct { // Name - The name of the Windows IoT Device Service to check. Name *string `json:"name,omitempty"` }
DeviceServiceCheckNameAvailabilityParameters input values.
type DeviceServiceDescriptionListResult ¶
type DeviceServiceDescriptionListResult struct { autorest.Response `json:"-"` // Value - The array of DeviceService objects. Value *[]DeviceService `json:"value,omitempty"` // NextLink - READ-ONLY; The next link. NextLink *string `json:"nextLink,omitempty"` }
DeviceServiceDescriptionListResult the JSON-serialized array of DeviceService objects with a next link.
func (DeviceServiceDescriptionListResult) IsEmpty ¶
func (dsdlr DeviceServiceDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (DeviceServiceDescriptionListResult) MarshalJSON ¶
func (dsdlr DeviceServiceDescriptionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceServiceDescriptionListResult.
type DeviceServiceDescriptionListResultIterator ¶
type DeviceServiceDescriptionListResultIterator struct {
// contains filtered or unexported fields
}
DeviceServiceDescriptionListResultIterator provides access to a complete listing of DeviceService values.
func NewDeviceServiceDescriptionListResultIterator ¶
func NewDeviceServiceDescriptionListResultIterator(page DeviceServiceDescriptionListResultPage) DeviceServiceDescriptionListResultIterator
Creates a new instance of the DeviceServiceDescriptionListResultIterator type.
func (*DeviceServiceDescriptionListResultIterator) Next ¶
func (iter *DeviceServiceDescriptionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*DeviceServiceDescriptionListResultIterator) NextWithContext ¶
func (iter *DeviceServiceDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (DeviceServiceDescriptionListResultIterator) NotDone ¶
func (iter DeviceServiceDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (DeviceServiceDescriptionListResultIterator) Response ¶
func (iter DeviceServiceDescriptionListResultIterator) Response() DeviceServiceDescriptionListResult
Response returns the raw server response from the last page request.
func (DeviceServiceDescriptionListResultIterator) Value ¶
func (iter DeviceServiceDescriptionListResultIterator) Value() DeviceService
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DeviceServiceDescriptionListResultPage ¶
type DeviceServiceDescriptionListResultPage struct {
// contains filtered or unexported fields
}
DeviceServiceDescriptionListResultPage contains a page of DeviceService values.
func NewDeviceServiceDescriptionListResultPage ¶
func NewDeviceServiceDescriptionListResultPage(cur DeviceServiceDescriptionListResult, getNextPage func(context.Context, DeviceServiceDescriptionListResult) (DeviceServiceDescriptionListResult, error)) DeviceServiceDescriptionListResultPage
Creates a new instance of the DeviceServiceDescriptionListResultPage type.
func (*DeviceServiceDescriptionListResultPage) Next ¶
func (page *DeviceServiceDescriptionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*DeviceServiceDescriptionListResultPage) NextWithContext ¶
func (page *DeviceServiceDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (DeviceServiceDescriptionListResultPage) NotDone ¶
func (page DeviceServiceDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (DeviceServiceDescriptionListResultPage) Response ¶
func (page DeviceServiceDescriptionListResultPage) Response() DeviceServiceDescriptionListResult
Response returns the raw server response from the last page request.
func (DeviceServiceDescriptionListResultPage) Values ¶
func (page DeviceServiceDescriptionListResultPage) Values() []DeviceService
Values returns the slice of values for the current page or nil if there are no values.
type DeviceServiceNameAvailabilityInfo ¶
type DeviceServiceNameAvailabilityInfo struct { autorest.Response `json:"-"` // NameAvailable - READ-ONLY; The value which indicates whether the provided name is available. NameAvailable *bool `json:"nameAvailable,omitempty"` // Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists' Reason ServiceNameUnavailabilityReason `json:"reason,omitempty"` // Message - The detailed reason message. Message *string `json:"message,omitempty"` }
DeviceServiceNameAvailabilityInfo the properties indicating whether a given Windows IoT Device Service name is available.
func (DeviceServiceNameAvailabilityInfo) MarshalJSON ¶
func (dsnai DeviceServiceNameAvailabilityInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceServiceNameAvailabilityInfo.
type DeviceServiceProperties ¶
type DeviceServiceProperties struct { // Notes - Windows IoT Device Service notes. Notes *string `json:"notes,omitempty"` // StartDate - READ-ONLY; Windows IoT Device Service start date, StartDate *date.Time `json:"startDate,omitempty"` // Quantity - Windows IoT Device Service device allocation, Quantity *int64 `json:"quantity,omitempty"` // BillingDomainName - Windows IoT Device Service ODM AAD domain BillingDomainName *string `json:"billingDomainName,omitempty"` // AdminDomainName - Windows IoT Device Service OEM AAD domain AdminDomainName *string `json:"adminDomainName,omitempty"` }
DeviceServiceProperties the properties of a Windows IoT Device Service.
func (DeviceServiceProperties) MarshalJSON ¶
func (dsp DeviceServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeviceServiceProperties.
type ErrorDetails ¶
type ErrorDetails struct { // Code - One of a server-defined set of error codes. Code *string `json:"code,omitempty"` // Message - A human-readable representation of the error. Message *string `json:"message,omitempty"` // Target - The target of the particular error. Target *string `json:"target,omitempty"` // Details - A human-readable representation of the error's details. Details *string `json:"details,omitempty"` }
ErrorDetails the details of the error.
type OperationDisplayInfo ¶
type OperationDisplayInfo struct { // Description - The description of the operation. Description *string `json:"description,omitempty"` // Operation - The action that users can perform, based on their permission level. Operation *string `json:"operation,omitempty"` // Provider - Service provider: Azure Data Catalog Service. Provider *string `json:"provider,omitempty"` // Resource - 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 { // Name - Operation name: {provider}/{resource}/{operation}. Name *string `json:"name,omitempty"` // Display - The operation supported by Azure Data Catalog Service. Display *OperationDisplayInfo `json:"display,omitempty"` }
OperationEntity the operation supported by Azure Data Catalog Service.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; List of Windows IoT Device Service operations supported by the Microsoft.WindowsIoT resource provider. Value *[]OperationEntity `json:"value,omitempty"` // NextLink - READ-ONLY; URL to get the next set of operation list results if there are any. NextLink *string `json:"nextLink,omitempty"` }
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) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of OperationEntity values.
func NewOperationListResultIterator ¶
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (*OperationListResultIterator) Next ¶
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultIterator) NextWithContext ¶
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OperationListResultIterator) NotDone ¶
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListResultIterator) Response ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
func (iter OperationListResultIterator) Value() OperationEntity
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage ¶
type OperationListResultPage struct {
// contains filtered or unexported fields
}
OperationListResultPage contains a page of OperationEntity values.
func NewOperationListResultPage ¶
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (*OperationListResultPage) Next ¶
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultPage) NextWithContext ¶
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OperationListResultPage) NotDone ¶
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListResultPage) Response ¶
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultPage) Values ¶
func (page OperationListResultPage) Values() []OperationEntity
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the use this API to manage the Windows IoT device services in your Azure subscription.
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Windows IoT Services REST API operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ProxyResource ¶
type ProxyResource struct { // ID - READ-ONLY; Fully qualified resource Id for the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. Type *string `json:"type,omitempty"` }
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 { // ID - READ-ONLY; Fully qualified resource Id for the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. Type *string `json:"type,omitempty"` }
Resource the core properties of ARM resources
type ServiceNameUnavailabilityReason ¶
type ServiceNameUnavailabilityReason string
ServiceNameUnavailabilityReason enumerates the values for service name unavailability reason.
const ( // AlreadyExists ... AlreadyExists ServiceNameUnavailabilityReason = "AlreadyExists" // Invalid ... Invalid ServiceNameUnavailabilityReason = "Invalid" )
func PossibleServiceNameUnavailabilityReasonValues ¶
func PossibleServiceNameUnavailabilityReasonValues() []ServiceNameUnavailabilityReason
PossibleServiceNameUnavailabilityReasonValues returns an array of possible values for the ServiceNameUnavailabilityReason const type.
type ServicesClient ¶
type ServicesClient struct {
BaseClient
}
ServicesClient is the use this API to manage the Windows IoT device services in your Azure subscription.
func NewServicesClient ¶
func NewServicesClient(subscriptionID string) ServicesClient
NewServicesClient creates an instance of the ServicesClient client.
func NewServicesClientWithBaseURI ¶
func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient
NewServicesClientWithBaseURI creates an instance of the ServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (ServicesClient) CheckDeviceServiceNameAvailability ¶
func (client ServicesClient) CheckDeviceServiceNameAvailability(ctx context.Context, deviceServiceCheckNameAvailabilityParameters DeviceServiceCheckNameAvailabilityParameters) (result DeviceServiceNameAvailabilityInfo, err error)
CheckDeviceServiceNameAvailability check if a Windows IoT Device Service name is available. Parameters: deviceServiceCheckNameAvailabilityParameters - set the name parameter in the DeviceServiceCheckNameAvailabilityParameters structure to the name of the Windows IoT Device Service to check.
func (ServicesClient) CheckDeviceServiceNameAvailabilityPreparer ¶
func (client ServicesClient) CheckDeviceServiceNameAvailabilityPreparer(ctx context.Context, deviceServiceCheckNameAvailabilityParameters DeviceServiceCheckNameAvailabilityParameters) (*http.Request, error)
CheckDeviceServiceNameAvailabilityPreparer prepares the CheckDeviceServiceNameAvailability request.
func (ServicesClient) CheckDeviceServiceNameAvailabilityResponder ¶
func (client ServicesClient) CheckDeviceServiceNameAvailabilityResponder(resp *http.Response) (result DeviceServiceNameAvailabilityInfo, err error)
CheckDeviceServiceNameAvailabilityResponder handles the response to the CheckDeviceServiceNameAvailability request. The method always closes the http.Response Body.
func (ServicesClient) CheckDeviceServiceNameAvailabilitySender ¶
func (client ServicesClient) CheckDeviceServiceNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckDeviceServiceNameAvailabilitySender sends the CheckDeviceServiceNameAvailability request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) CreateOrUpdate ¶
func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, deviceName string, deviceService DeviceServiceProperties, ifMatch string) (result DeviceService, err 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. Parameters: resourceGroupName - the name of the resource group that contains the Windows IoT Device Service. deviceName - the name of the Windows IoT Device Service. deviceService - the Windows IoT Device Service metadata and security metadata. ifMatch - 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.
func (ServicesClient) CreateOrUpdatePreparer ¶
func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, deviceName string, deviceService DeviceServiceProperties, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (ServicesClient) CreateOrUpdateResponder ¶
func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result DeviceService, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (ServicesClient) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Delete ¶
func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, deviceName string) (result DeviceService, err error)
Delete delete a Windows IoT Device Service. Parameters: resourceGroupName - the name of the resource group that contains the Windows IoT Device Service. deviceName - the name of the Windows IoT Device Service.
func (ServicesClient) DeletePreparer ¶
func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, deviceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (ServicesClient) DeleteResponder ¶
func (client ServicesClient) DeleteResponder(resp *http.Response) (result DeviceService, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (ServicesClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Get ¶
func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, deviceName string) (result DeviceService, err error)
Get get the non-security related metadata of a Windows IoT Device Service. Parameters: resourceGroupName - the name of the resource group that contains the Windows IoT Device Service. deviceName - the name of the Windows IoT Device Service.
func (ServicesClient) GetPreparer ¶
func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, deviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (ServicesClient) GetResponder ¶
func (client ServicesClient) GetResponder(resp *http.Response) (result DeviceService, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (ServicesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) List ¶
func (client ServicesClient) List(ctx context.Context) (result DeviceServiceDescriptionListResultPage, err error)
List get all the IoT hubs in a subscription.
func (ServicesClient) ListByResourceGroup ¶
func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DeviceServiceDescriptionListResultPage, err error)
ListByResourceGroup get all the IoT hubs in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the Windows IoT Device Service.
func (ServicesClient) ListByResourceGroupComplete ¶
func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DeviceServiceDescriptionListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (ServicesClient) ListByResourceGroupPreparer ¶
func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (ServicesClient) ListByResourceGroupResponder ¶
func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result DeviceServiceDescriptionListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (ServicesClient) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) ListComplete ¶
func (client ServicesClient) ListComplete(ctx context.Context) (result DeviceServiceDescriptionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (ServicesClient) ListPreparer ¶
ListPreparer prepares the List request.
func (ServicesClient) ListResponder ¶
func (client ServicesClient) ListResponder(resp *http.Response) (result DeviceServiceDescriptionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ServicesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Update ¶
func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, deviceName string, deviceService DeviceServiceProperties, ifMatch string) (result DeviceService, err 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. Parameters: resourceGroupName - the name of the resource group that contains the Windows IoT Device Service. deviceName - the name of the Windows IoT Device Service. deviceService - the Windows IoT Device Service metadata and security metadata. ifMatch - 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.
func (ServicesClient) UpdatePreparer ¶
func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, deviceName string, deviceService DeviceServiceProperties, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (ServicesClient) UpdateResponder ¶
func (client ServicesClient) UpdateResponder(resp *http.Response) (result DeviceService, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (ServicesClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type TrackedResource ¶
type TrackedResource struct { // Tags - Resource tags. Tags map[string]*string `json:"tags"` // Location - The Azure Region where the resource lives Location *string `json:"location,omitempty"` // ID - READ-ONLY; Fully qualified resource Id for the resource ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. Type *string `json:"type,omitempty"` }
TrackedResource the resource model definition for a ARM tracked top level resource
func (TrackedResource) MarshalJSON ¶
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.