iotdpsresource

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/deviceprovisioningservices/2022-02-05/iotdpsresource Documentation

The iotdpsresource SDK allows for interaction with Azure Resource Manager deviceprovisioningservices (API Version 2022-02-05).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/deviceprovisioningservices/2022-02-05/iotdpsresource"

Client Initialization

client := iotdpsresource.NewIotDpsResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IotDpsResourceClient.CheckProvisioningServiceNameAvailability

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := iotdpsresource.OperationInputs{
	// ...
}


read, err := client.CheckProvisioningServiceNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.CreateOrUpdate

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

payload := iotdpsresource.ProvisioningServiceDescription{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.CreateOrUpdatePrivateEndpointConnection

ctx := context.TODO()
id := iotdpsresource.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName", "privateEndpointConnectionName")

payload := iotdpsresource.PrivateEndpointConnection{
	// ...
}


if err := client.CreateOrUpdatePrivateEndpointConnectionThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.Delete

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.DeletePrivateEndpointConnection

ctx := context.TODO()
id := iotdpsresource.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName", "privateEndpointConnectionName")

if err := client.DeletePrivateEndpointConnectionThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.Get

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.GetPrivateEndpointConnection

ctx := context.TODO()
id := iotdpsresource.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName", "privateEndpointConnectionName")

read, err := client.GetPrivateEndpointConnection(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.GetPrivateLinkResources

ctx := context.TODO()
id := iotdpsresource.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName", "groupId")

read, err := client.GetPrivateLinkResources(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.ListKeys

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

// alternatively `client.ListKeys(ctx, id)` can be used to do batched pagination
items, err := client.ListKeysComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.ListKeysForKeyName

ctx := context.TODO()
id := iotdpsresource.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName", "keyName")

read, err := client.ListKeysForKeyName(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListPrivateEndpointConnections

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

read, err := client.ListPrivateEndpointConnections(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListPrivateLinkResources

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

read, err := client.ListPrivateLinkResources(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListValidSkus

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

// alternatively `client.ListValidSkus(ctx, id)` can be used to do batched pagination
items, err := client.ListValidSkusComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.Update

ctx := context.TODO()
id := commonids.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceName")

payload := iotdpsresource.TagsResource{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessRightsDescription 

func PossibleValuesForAccessRightsDescription() []string

func PossibleValuesForAllocationPolicy 

func PossibleValuesForAllocationPolicy() []string

func PossibleValuesForIPFilterActionType 

func PossibleValuesForIPFilterActionType() []string

func PossibleValuesForIPFilterTargetType 

func PossibleValuesForIPFilterTargetType() []string

func PossibleValuesForIotDpsSku 

func PossibleValuesForIotDpsSku() []string

func PossibleValuesForNameUnavailabilityReason 

func PossibleValuesForNameUnavailabilityReason() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus 

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForState 

func PossibleValuesForState() []string

func ValidateKeyID 

func ValidateKeyID(input interface{}, key string) (warnings []string, errors []error)

ValidateKeyID checks that 'input' can be parsed as a Key ID

func ValidatePrivateEndpointConnectionID 

func ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateEndpointConnectionID checks that 'input' can be parsed as a Private Endpoint Connection ID

func ValidatePrivateLinkResourceID 

func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateLinkResourceID checks that 'input' can be parsed as a Private Link Resource ID

Types

type AccessRightsDescription 

type AccessRightsDescription string
const (
	AccessRightsDescriptionDeviceConnect           AccessRightsDescription = "DeviceConnect"
	AccessRightsDescriptionEnrollmentRead          AccessRightsDescription = "EnrollmentRead"
	AccessRightsDescriptionEnrollmentWrite         AccessRightsDescription = "EnrollmentWrite"
	AccessRightsDescriptionRegistrationStatusRead  AccessRightsDescription = "RegistrationStatusRead"
	AccessRightsDescriptionRegistrationStatusWrite AccessRightsDescription = "RegistrationStatusWrite"
	AccessRightsDescriptionServiceConfig           AccessRightsDescription = "ServiceConfig"
)

func (*AccessRightsDescription) UnmarshalJSON 

func (s *AccessRightsDescription) UnmarshalJSON(bytes []byte) error

type AllocationPolicy 

type AllocationPolicy string
const (
	AllocationPolicyGeoLatency AllocationPolicy = "GeoLatency"
	AllocationPolicyHashed     AllocationPolicy = "Hashed"
	AllocationPolicyStatic     AllocationPolicy = "Static"
)

func (*AllocationPolicy) UnmarshalJSON 

func (s *AllocationPolicy) UnmarshalJSON(bytes []byte) error

type CheckProvisioningServiceNameAvailabilityOperationResponse 

type CheckProvisioningServiceNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NameAvailabilityInfo
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProvisioningServiceDescription
}

type CreateOrUpdatePrivateEndpointConnectionOperationResponse 

type CreateOrUpdatePrivateEndpointConnectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeletePrivateEndpointConnectionOperationResponse 

type DeletePrivateEndpointConnectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProvisioningServiceDescription
}

type GetPrivateEndpointConnectionOperationResponse 

type GetPrivateEndpointConnectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type GetPrivateLinkResourcesOperationResponse 

type GetPrivateLinkResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupIdInformation
}

type GroupIdInformation 

type GroupIdInformation struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties GroupIdInformationProperties `json:"properties"`
	Type       *string                      `json:"type,omitempty"`
}

type GroupIdInformationProperties 

type GroupIdInformationProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type IPFilterActionType 

type IPFilterActionType string
const (
	IPFilterActionTypeAccept IPFilterActionType = "Accept"
	IPFilterActionTypeReject IPFilterActionType = "Reject"
)

func (*IPFilterActionType) UnmarshalJSON 

func (s *IPFilterActionType) UnmarshalJSON(bytes []byte) error

type IPFilterRule 

type IPFilterRule struct {
	Action     IPFilterActionType  `json:"action"`
	FilterName string              `json:"filterName"`
	IPMask     string              `json:"ipMask"`
	Target     *IPFilterTargetType `json:"target,omitempty"`
}

type IPFilterTargetType 

type IPFilterTargetType string
const (
	IPFilterTargetTypeAll        IPFilterTargetType = "all"
	IPFilterTargetTypeDeviceApi  IPFilterTargetType = "deviceApi"
	IPFilterTargetTypeServiceApi IPFilterTargetType = "serviceApi"
)

func (*IPFilterTargetType) UnmarshalJSON 

func (s *IPFilterTargetType) UnmarshalJSON(bytes []byte) error

type IotDpsPropertiesDescription 

type IotDpsPropertiesDescription struct {
	AllocationPolicy           *AllocationPolicy                                                `json:"allocationPolicy,omitempty"`
	AuthorizationPolicies      *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"authorizationPolicies,omitempty"`
	DeviceProvisioningHostName *string                                                          `json:"deviceProvisioningHostName,omitempty"`
	EnableDataResidency        *bool                                                            `json:"enableDataResidency,omitempty"`
	IPFilterRules              *[]IPFilterRule                                                  `json:"ipFilterRules,omitempty"`
	IdScope                    *string                                                          `json:"idScope,omitempty"`
	IotHubs                    *[]IotHubDefinitionDescription                                   `json:"iotHubs,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection                                     `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                                                          `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess                                             `json:"publicNetworkAccess,omitempty"`
	ServiceOperationsHostName  *string                                                          `json:"serviceOperationsHostName,omitempty"`
	State                      *State                                                           `json:"state,omitempty"`
}

type IotDpsResourceClient 

type IotDpsResourceClient struct {
	Client *resourcemanager.Client
}

func NewIotDpsResourceClientWithBaseURI 

func NewIotDpsResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*IotDpsResourceClient, error)

func (IotDpsResourceClient) CheckProvisioningServiceNameAvailability 

func (c IotDpsResourceClient) CheckProvisioningServiceNameAvailability(ctx context.Context, id commonids.SubscriptionId, input OperationInputs) (result CheckProvisioningServiceNameAvailabilityOperationResponse, err error)

CheckProvisioningServiceNameAvailability ...

func (IotDpsResourceClient) CreateOrUpdate 

func (c IotDpsResourceClient) CreateOrUpdate(ctx context.Context, id commonids.ProvisioningServiceId, input ProvisioningServiceDescription) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnection 

func (c IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result CreateOrUpdatePrivateEndpointConnectionOperationResponse, err error)

CreateOrUpdatePrivateEndpointConnection ...

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionThenPoll 

func (c IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error

CreateOrUpdatePrivateEndpointConnectionThenPoll performs CreateOrUpdatePrivateEndpointConnection then polls until it's completed

func (IotDpsResourceClient) CreateOrUpdateThenPoll 

func (c IotDpsResourceClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.ProvisioningServiceId, input ProvisioningServiceDescription) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (IotDpsResourceClient) Delete 

func (c IotDpsResourceClient) Delete(ctx context.Context, id commonids.ProvisioningServiceId) (result DeleteOperationResponse, err error)

Delete ...

func (IotDpsResourceClient) DeletePrivateEndpointConnection 

func (c IotDpsResourceClient) DeletePrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId) (result DeletePrivateEndpointConnectionOperationResponse, err error)

DeletePrivateEndpointConnection ...

func (IotDpsResourceClient) DeletePrivateEndpointConnectionThenPoll 

func (c IotDpsResourceClient) DeletePrivateEndpointConnectionThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error

DeletePrivateEndpointConnectionThenPoll performs DeletePrivateEndpointConnection then polls until it's completed

func (IotDpsResourceClient) DeleteThenPoll 

func (c IotDpsResourceClient) DeleteThenPoll(ctx context.Context, id commonids.ProvisioningServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (IotDpsResourceClient) Get 

func (c IotDpsResourceClient) Get(ctx context.Context, id commonids.ProvisioningServiceId) (result GetOperationResponse, err error)

Get ...

func (IotDpsResourceClient) GetPrivateEndpointConnection 

func (c IotDpsResourceClient) GetPrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId) (result GetPrivateEndpointConnectionOperationResponse, err error)

GetPrivateEndpointConnection ...

func (IotDpsResourceClient) GetPrivateLinkResources 

func (c IotDpsResourceClient) GetPrivateLinkResources(ctx context.Context, id PrivateLinkResourceId) (result GetPrivateLinkResourcesOperationResponse, err error)

GetPrivateLinkResources ...

func (IotDpsResourceClient) ListByResourceGroup 

func (c IotDpsResourceClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (IotDpsResourceClient) ListByResourceGroupComplete 

func (c IotDpsResourceClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListByResourceGroupCompleteMatchingPredicate 

func (c IotDpsResourceClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ProvisioningServiceDescriptionOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) ListBySubscription 

func (c IotDpsResourceClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (IotDpsResourceClient) ListBySubscriptionComplete 

func (c IotDpsResourceClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListBySubscriptionCompleteMatchingPredicate 

func (c IotDpsResourceClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ProvisioningServiceDescriptionOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) ListKeys 

func (c IotDpsResourceClient) ListKeys(ctx context.Context, id commonids.ProvisioningServiceId) (result ListKeysOperationResponse, err error)

ListKeys ...

func (IotDpsResourceClient) ListKeysComplete 

func (c IotDpsResourceClient) ListKeysComplete(ctx context.Context, id commonids.ProvisioningServiceId) (ListKeysCompleteResult, error)

ListKeysComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListKeysCompleteMatchingPredicate 

func (c IotDpsResourceClient) ListKeysCompleteMatchingPredicate(ctx context.Context, id commonids.ProvisioningServiceId, predicate SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate) (result ListKeysCompleteResult, err error)

ListKeysCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) ListKeysForKeyName 

func (c IotDpsResourceClient) ListKeysForKeyName(ctx context.Context, id KeyId) (result ListKeysForKeyNameOperationResponse, err error)

ListKeysForKeyName ...

func (IotDpsResourceClient) ListPrivateEndpointConnections 

func (c IotDpsResourceClient) ListPrivateEndpointConnections(ctx context.Context, id commonids.ProvisioningServiceId) (result ListPrivateEndpointConnectionsOperationResponse, err error)

ListPrivateEndpointConnections ...

func (IotDpsResourceClient) ListPrivateLinkResources 

func (c IotDpsResourceClient) ListPrivateLinkResources(ctx context.Context, id commonids.ProvisioningServiceId) (result ListPrivateLinkResourcesOperationResponse, err error)

ListPrivateLinkResources ...

func (IotDpsResourceClient) ListValidSkus 

func (c IotDpsResourceClient) ListValidSkus(ctx context.Context, id commonids.ProvisioningServiceId) (result ListValidSkusOperationResponse, err error)

ListValidSkus ...

func (IotDpsResourceClient) ListValidSkusComplete 

func (c IotDpsResourceClient) ListValidSkusComplete(ctx context.Context, id commonids.ProvisioningServiceId) (ListValidSkusCompleteResult, error)

ListValidSkusComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListValidSkusCompleteMatchingPredicate 

func (c IotDpsResourceClient) ListValidSkusCompleteMatchingPredicate(ctx context.Context, id commonids.ProvisioningServiceId, predicate IotDpsSkuDefinitionOperationPredicate) (result ListValidSkusCompleteResult, err error)

ListValidSkusCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) Update 

func (c IotDpsResourceClient) Update(ctx context.Context, id commonids.ProvisioningServiceId, input TagsResource) (result UpdateOperationResponse, err error)

Update ...

func (IotDpsResourceClient) UpdateThenPoll 

func (c IotDpsResourceClient) UpdateThenPoll(ctx context.Context, id commonids.ProvisioningServiceId, input TagsResource) error

UpdateThenPoll performs Update then polls until it's completed

type IotDpsSku 

type IotDpsSku string
const (
	IotDpsSkuSOne IotDpsSku = "S1"
)

func (*IotDpsSku) UnmarshalJSON 

func (s *IotDpsSku) UnmarshalJSON(bytes []byte) error

type IotDpsSkuDefinition 

type IotDpsSkuDefinition struct {
	Name *IotDpsSku `json:"name,omitempty"`
}

type IotDpsSkuDefinitionOperationPredicate 

type IotDpsSkuDefinitionOperationPredicate struct {
}

func (IotDpsSkuDefinitionOperationPredicate) Matches 

func (p IotDpsSkuDefinitionOperationPredicate) Matches(input IotDpsSkuDefinition) bool

type IotDpsSkuInfo 

type IotDpsSkuInfo struct {
	Capacity *int64     `json:"capacity,omitempty"`
	Name     *IotDpsSku `json:"name,omitempty"`
	Tier     *string    `json:"tier,omitempty"`
}

type IotHubDefinitionDescription 

type IotHubDefinitionDescription struct {
	AllocationWeight      *int64  `json:"allocationWeight,omitempty"`
	ApplyAllocationPolicy *bool   `json:"applyAllocationPolicy,omitempty"`
	ConnectionString      string  `json:"connectionString"`
	Location              string  `json:"location"`
	Name                  *string `json:"name,omitempty"`
}

type KeyId 

type KeyId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ProvisioningServiceName string
	KeyName                 string
}

KeyId is a struct representing the Resource ID for a Key

func NewKeyID 

func NewKeyID(subscriptionId string, resourceGroupName string, provisioningServiceName string, keyName string) KeyId

NewKeyID returns a new KeyId struct

func ParseKeyID 

func ParseKeyID(input string) (*KeyId, error)

ParseKeyID parses 'input' into a KeyId

func ParseKeyIDInsensitively 

func ParseKeyIDInsensitively(input string) (*KeyId, error)

ParseKeyIDInsensitively parses 'input' case-insensitively into a KeyId note: this method should only be used for API response data and not user input

func (*KeyId) FromParseResult 

func (id *KeyId) FromParseResult(input resourceids.ParseResult) error

func (KeyId) ID 

func (id KeyId) ID() string

ID returns the formatted Key ID

func (KeyId) Segments 

func (id KeyId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Key ID

func (KeyId) String 

func (id KeyId) String() string

String returns a human-readable description of this Key ID

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProvisioningServiceDescription
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProvisioningServiceDescription
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProvisioningServiceDescription
}

type ListBySubscriptionCustomPager added in v0.20240628.1153531 

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProvisioningServiceDescription
}

type ListKeysCompleteResult 

type ListKeysCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

type ListKeysCustomPager added in v0.20240628.1153531 

type ListKeysCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListKeysCustomPager) NextPageLink() *odata.Link

type ListKeysForKeyNameOperationResponse 

type ListKeysForKeyNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

type ListKeysOperationResponse 

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

type ListPrivateEndpointConnectionsOperationResponse 

type ListPrivateEndpointConnectionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnection
}

type ListPrivateLinkResourcesOperationResponse 

type ListPrivateLinkResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResources
}

type ListValidSkusCompleteResult 

type ListValidSkusCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IotDpsSkuDefinition
}

type ListValidSkusCustomPager added in v0.20240628.1153531 

type ListValidSkusCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListValidSkusCustomPager) NextPageLink() *odata.Link

type ListValidSkusOperationResponse 

type ListValidSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IotDpsSkuDefinition
}

type NameAvailabilityInfo 

type NameAvailabilityInfo struct {
	Message       *string                   `json:"message,omitempty"`
	NameAvailable *bool                     `json:"nameAvailable,omitempty"`
	Reason        *NameUnavailabilityReason `json:"reason,omitempty"`
}

type NameUnavailabilityReason 

type NameUnavailabilityReason string
const (
	NameUnavailabilityReasonAlreadyExists NameUnavailabilityReason = "AlreadyExists"
	NameUnavailabilityReasonInvalid       NameUnavailabilityReason = "Invalid"
)

func (*NameUnavailabilityReason) UnmarshalJSON 

func (s *NameUnavailabilityReason) UnmarshalJSON(bytes []byte) error

type OperationInputs 

type OperationInputs struct {
	Name string `json:"name"`
}

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Id         *string                             `json:"id,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties PrivateEndpointConnectionProperties `json:"properties"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type PrivateEndpointConnectionId 

type PrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	ProvisioningServiceName       string
	PrivateEndpointConnectionName string
}

PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, provisioningServiceName string, privateEndpointConnectionName string) PrivateEndpointConnectionId

NewPrivateEndpointConnectionID returns a new PrivateEndpointConnectionId struct

func ParsePrivateEndpointConnectionID 

func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionID parses 'input' into a PrivateEndpointConnectionId

func ParsePrivateEndpointConnectionIDInsensitively 

func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionIDInsensitively parses 'input' case-insensitively into a PrivateEndpointConnectionId note: this method should only be used for API response data and not user input

func (*PrivateEndpointConnectionId) FromParseResult 

func (id *PrivateEndpointConnectionId) FromParseResult(input resourceids.ParseResult) error

func (PrivateEndpointConnectionId) ID 

func (id PrivateEndpointConnectionId) ID() string

ID returns the formatted Private Endpoint Connection ID

func (PrivateEndpointConnectionId) Segments 

func (id PrivateEndpointConnectionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Endpoint Connection ID

func (PrivateEndpointConnectionId) String 

func (id PrivateEndpointConnectionId) String() string

String returns a human-readable description of this Private Endpoint Connection ID

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                  `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState"`
}

type PrivateLinkResourceId 

type PrivateLinkResourceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ProvisioningServiceName string
	GroupId                 string
}

PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource

func NewPrivateLinkResourceID 

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, provisioningServiceName string, groupId string) PrivateLinkResourceId

NewPrivateLinkResourceID returns a new PrivateLinkResourceId struct

func ParsePrivateLinkResourceID 

func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceID parses 'input' into a PrivateLinkResourceId

func ParsePrivateLinkResourceIDInsensitively 

func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceIDInsensitively parses 'input' case-insensitively into a PrivateLinkResourceId note: this method should only be used for API response data and not user input

func (*PrivateLinkResourceId) FromParseResult 

func (id *PrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error

func (PrivateLinkResourceId) ID 

func (id PrivateLinkResourceId) ID() string

ID returns the formatted Private Link Resource ID

func (PrivateLinkResourceId) Segments 

func (id PrivateLinkResourceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Link Resource ID

func (PrivateLinkResourceId) String 

func (id PrivateLinkResourceId) String() string

String returns a human-readable description of this Private Link Resource ID

type PrivateLinkResources 

type PrivateLinkResources struct {
	Value *[]GroupIdInformation `json:"value,omitempty"`
}

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                            `json:"actionsRequired,omitempty"`
	Description     string                             `json:"description"`
	Status          PrivateLinkServiceConnectionStatus `json:"status"`
}

type PrivateLinkServiceConnectionStatus 

type PrivateLinkServiceConnectionStatus string
const (
	PrivateLinkServiceConnectionStatusApproved     PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	PrivateLinkServiceConnectionStatusPending      PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected     PrivateLinkServiceConnectionStatus = "Rejected"
)

func (*PrivateLinkServiceConnectionStatus) UnmarshalJSON 

func (s *PrivateLinkServiceConnectionStatus) UnmarshalJSON(bytes []byte) error

type ProvisioningServiceDescription 

type ProvisioningServiceDescription struct {
	Etag       *string                     `json:"etag,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Location   string                      `json:"location"`
	Name       *string                     `json:"name,omitempty"`
	Properties IotDpsPropertiesDescription `json:"properties"`
	Sku        IotDpsSkuInfo               `json:"sku"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type ProvisioningServiceDescriptionOperationPredicate 

type ProvisioningServiceDescriptionOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ProvisioningServiceDescriptionOperationPredicate) Matches 

func (p ProvisioningServiceDescriptionOperationPredicate) Matches(input ProvisioningServiceDescription) bool

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON 

func (s *PublicNetworkAccess) UnmarshalJSON(bytes []byte) error

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription 

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription struct {
	KeyName      string                  `json:"keyName"`
	PrimaryKey   *string                 `json:"primaryKey,omitempty"`
	Rights       AccessRightsDescription `json:"rights"`
	SecondaryKey *string                 `json:"secondaryKey,omitempty"`
}

type SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate 

type SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate struct {
	KeyName      *string
	PrimaryKey   *string
	SecondaryKey *string
}

func (SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate) Matches 

func (p SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate) Matches(input SharedAccessSignatureAuthorizationRuleAccessRightsDescription) bool

type State 

type State string
const (
	StateActivating       State = "Activating"
	StateActivationFailed State = "ActivationFailed"
	StateActive           State = "Active"
	StateDeleted          State = "Deleted"
	StateDeleting         State = "Deleting"
	StateDeletionFailed   State = "DeletionFailed"
	StateFailingOver      State = "FailingOver"
	StateFailoverFailed   State = "FailoverFailed"
	StateResuming         State = "Resuming"
	StateSuspended        State = "Suspended"
	StateSuspending       State = "Suspending"
	StateTransitioning    State = "Transitioning"
)

func (*State) UnmarshalJSON 

func (s *State) UnmarshalJSON(bytes []byte) error

type TagsResource 

type TagsResource struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProvisioningServiceDescription
}

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.