policytokens

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2025-03-01/policytokens Documentation

The policytokens SDK allows for interaction with Azure Resource Manager resources (API Version 2025-03-01).

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/resources/2025-03-01/policytokens"

Client Initialization

client := policytokens.NewPolicyTokensClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PolicyTokensClient.Acquire

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

payload := policytokens.PolicyTokenRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForExternalEndpointResult() []string
• func PossibleValuesForPolicyTokenResult() []string
• type AcquireOperationResponse
• type ExternalEndpointResult
  • func (s *ExternalEndpointResult) UnmarshalJSON(bytes []byte) error
• type ExternalEvaluationEndpointInvocationResult
  • func (o *ExternalEvaluationEndpointInvocationResult) GetExpirationAsTime() (*time.Time, error)
  • func (o *ExternalEvaluationEndpointInvocationResult) GetRetryAfterAsTime() (*time.Time, error)
  • func (o *ExternalEvaluationEndpointInvocationResult) SetExpirationAsTime(input time.Time)
  • func (o *ExternalEvaluationEndpointInvocationResult) SetRetryAfterAsTime(input time.Time)
• type PolicyLogInfo
• type PolicyTokenOperation
• type PolicyTokenRequest
• type PolicyTokenResponse
  • func (o *PolicyTokenResponse) GetExpirationAsTime() (*time.Time, error)
  • func (o *PolicyTokenResponse) GetRetryAfterAsTime() (*time.Time, error)
  • func (o *PolicyTokenResponse) SetExpirationAsTime(input time.Time)
  • func (o *PolicyTokenResponse) SetRetryAfterAsTime(input time.Time)
• type PolicyTokenResult
  • func (s *PolicyTokenResult) UnmarshalJSON(bytes []byte) error
• type PolicyTokensClient
  • func NewPolicyTokensClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyTokensClient, error)
  • func (c PolicyTokensClient) Acquire(ctx context.Context, id commonids.SubscriptionId, input PolicyTokenRequest) (result AcquireOperationResponse, err error)
  • func (c PolicyTokensClient) AcquireThenPoll(ctx context.Context, id commonids.SubscriptionId, input PolicyTokenRequest) error

Functions

func PossibleValuesForExternalEndpointResult

func PossibleValuesForExternalEndpointResult() []string

func PossibleValuesForPolicyTokenResult

func PossibleValuesForPolicyTokenResult() []string

Types

type AcquireOperationResponse

type AcquireOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PolicyTokenResponse
}

type ExternalEndpointResult

type ExternalEndpointResult string

const (
	ExternalEndpointResultFailed    ExternalEndpointResult = "Failed"
	ExternalEndpointResultSucceeded ExternalEndpointResult = "Succeeded"
)

func (*ExternalEndpointResult) UnmarshalJSON

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

type ExternalEvaluationEndpointInvocationResult

type ExternalEvaluationEndpointInvocationResult struct {
	Claims     *interface{}            `json:"claims,omitempty"`
	Expiration *string                 `json:"expiration,omitempty"`
	Message    *string                 `json:"message,omitempty"`
	PolicyInfo *PolicyLogInfo          `json:"policyInfo,omitempty"`
	Result     *ExternalEndpointResult `json:"result,omitempty"`
	RetryAfter *string                 `json:"retryAfter,omitempty"`
}

func (*ExternalEvaluationEndpointInvocationResult) GetExpirationAsTime

func (o *ExternalEvaluationEndpointInvocationResult) GetExpirationAsTime() (*time.Time, error)

func (*ExternalEvaluationEndpointInvocationResult) GetRetryAfterAsTime

func (o *ExternalEvaluationEndpointInvocationResult) GetRetryAfterAsTime() (*time.Time, error)

func (*ExternalEvaluationEndpointInvocationResult) SetExpirationAsTime

func (o *ExternalEvaluationEndpointInvocationResult) SetExpirationAsTime(input time.Time)

func (*ExternalEvaluationEndpointInvocationResult) SetRetryAfterAsTime

func (o *ExternalEvaluationEndpointInvocationResult) SetRetryAfterAsTime(input time.Time)

type PolicyLogInfo

type PolicyLogInfo struct {
	Ancestors                      *string   `json:"ancestors,omitempty"`
	ComplianceReasonCode           *string   `json:"complianceReasonCode,omitempty"`
	PolicyAssignmentDisplayName    *string   `json:"policyAssignmentDisplayName,omitempty"`
	PolicyAssignmentId             *string   `json:"policyAssignmentId,omitempty"`
	PolicyAssignmentName           *string   `json:"policyAssignmentName,omitempty"`
	PolicyAssignmentScope          *string   `json:"policyAssignmentScope,omitempty"`
	PolicyAssignmentVersion        *string   `json:"policyAssignmentVersion,omitempty"`
	PolicyDefinitionDisplayName    *string   `json:"policyDefinitionDisplayName,omitempty"`
	PolicyDefinitionEffect         *string   `json:"policyDefinitionEffect,omitempty"`
	PolicyDefinitionGroupNames     *[]string `json:"policyDefinitionGroupNames,omitempty"`
	PolicyDefinitionId             *string   `json:"policyDefinitionId,omitempty"`
	PolicyDefinitionName           *string   `json:"policyDefinitionName,omitempty"`
	PolicyDefinitionReferenceId    *string   `json:"policyDefinitionReferenceId,omitempty"`
	PolicyDefinitionVersion        *string   `json:"policyDefinitionVersion,omitempty"`
	PolicyExemptionIds             *[]string `json:"policyExemptionIds,omitempty"`
	PolicySetDefinitionCategory    *string   `json:"policySetDefinitionCategory,omitempty"`
	PolicySetDefinitionDisplayName *string   `json:"policySetDefinitionDisplayName,omitempty"`
	PolicySetDefinitionId          *string   `json:"policySetDefinitionId,omitempty"`
	PolicySetDefinitionName        *string   `json:"policySetDefinitionName,omitempty"`
	PolicySetDefinitionVersion     *string   `json:"policySetDefinitionVersion,omitempty"`
	ResourceLocation               *string   `json:"resourceLocation,omitempty"`
}

type PolicyTokenOperation

type PolicyTokenOperation struct {
	Content    *interface{} `json:"content,omitempty"`
	HTTPMethod *string      `json:"httpMethod,omitempty"`
	Uri        *string      `json:"uri,omitempty"`
}

type PolicyTokenRequest

type PolicyTokenRequest struct {
	ChangeReference *string               `json:"changeReference,omitempty"`
	Operation       *PolicyTokenOperation `json:"operation,omitempty"`
}

type PolicyTokenResponse

type PolicyTokenResponse struct {
	ChangeReference *string                                       `json:"changeReference,omitempty"`
	Expiration      *string                                       `json:"expiration,omitempty"`
	Message         *string                                       `json:"message,omitempty"`
	Result          *PolicyTokenResult                            `json:"result,omitempty"`
	Results         *[]ExternalEvaluationEndpointInvocationResult `json:"results,omitempty"`
	RetryAfter      *string                                       `json:"retryAfter,omitempty"`
	Token           *string                                       `json:"token,omitempty"`
	TokenId         *string                                       `json:"tokenId,omitempty"`
}

func (*PolicyTokenResponse) GetExpirationAsTime

func (o *PolicyTokenResponse) GetExpirationAsTime() (*time.Time, error)

func (*PolicyTokenResponse) GetRetryAfterAsTime

func (o *PolicyTokenResponse) GetRetryAfterAsTime() (*time.Time, error)

func (*PolicyTokenResponse) SetExpirationAsTime

func (o *PolicyTokenResponse) SetExpirationAsTime(input time.Time)

func (*PolicyTokenResponse) SetRetryAfterAsTime

func (o *PolicyTokenResponse) SetRetryAfterAsTime(input time.Time)

type PolicyTokenResult

type PolicyTokenResult string

const (
	PolicyTokenResultFailed    PolicyTokenResult = "Failed"
	PolicyTokenResultSucceeded PolicyTokenResult = "Succeeded"
)

func (*PolicyTokenResult) UnmarshalJSON

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

type PolicyTokensClient

type PolicyTokensClient struct {
	Client *resourcemanager.Client
}

func NewPolicyTokensClientWithBaseURI

func NewPolicyTokensClientWithBaseURI(sdkApi sdkEnv.Api) (*PolicyTokensClient, error)

func (PolicyTokensClient) Acquire

func (c PolicyTokensClient) Acquire(ctx context.Context, id commonids.SubscriptionId, input PolicyTokenRequest) (result AcquireOperationResponse, err error)

Acquire ...

func (PolicyTokensClient) AcquireThenPoll

func (c PolicyTokensClient) AcquireThenPoll(ctx context.Context, id commonids.SubscriptionId, input PolicyTokenRequest) error

AcquireThenPoll performs Acquire then polls until it's completed