armauthorization

package module
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2022 License: MIT Imports: 14 Imported by: 15

README

Azure Authorization Module for Go

PkgGoDev

The armauthorization module provides operations for working with Azure Authorization.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Authorization module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization

Authorization

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

More sample code

Provide Feedback

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

type AccessRecommendationType string

AccessRecommendationType - The feature- generated recommendation shown to the reviewer. 

const (
	AccessRecommendationTypeApprove         AccessRecommendationType = "Approve"
	AccessRecommendationTypeDeny            AccessRecommendationType = "Deny"
	AccessRecommendationTypeNoInfoAvailable AccessRecommendationType = "NoInfoAvailable"
)

func PossibleAccessRecommendationTypeValues 

func PossibleAccessRecommendationTypeValues() []AccessRecommendationType

PossibleAccessRecommendationTypeValues returns the possible values for the AccessRecommendationType const type.

func (AccessRecommendationType) ToPtr 

func (c AccessRecommendationType) ToPtr() *AccessRecommendationType

ToPtr returns a *AccessRecommendationType pointing to the current value.

type AccessReviewActorIdentity 

type AccessReviewActorIdentity struct {
	// READ-ONLY; The identity id
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The identity display name
	PrincipalName *string `json:"principalName,omitempty" azure:"ro"`

	// READ-ONLY; The identity type : user/servicePrincipal
	PrincipalType *AccessReviewActorIdentityType `json:"principalType,omitempty" azure:"ro"`

	// READ-ONLY; The user principal name(if valid)
	UserPrincipalName *string `json:"userPrincipalName,omitempty" azure:"ro"`
}

AccessReviewActorIdentity - Details of the actor identity

type AccessReviewActorIdentityType 

type AccessReviewActorIdentityType string

AccessReviewActorIdentityType - The identity type : user/servicePrincipal 

const (
	AccessReviewActorIdentityTypeServicePrincipal AccessReviewActorIdentityType = "servicePrincipal"
	AccessReviewActorIdentityTypeUser             AccessReviewActorIdentityType = "user"
)

func PossibleAccessReviewActorIdentityTypeValues 

func PossibleAccessReviewActorIdentityTypeValues() []AccessReviewActorIdentityType

PossibleAccessReviewActorIdentityTypeValues returns the possible values for the AccessReviewActorIdentityType const type.

func (AccessReviewActorIdentityType) ToPtr 

func (c AccessReviewActorIdentityType) ToPtr() *AccessReviewActorIdentityType

ToPtr returns a *AccessReviewActorIdentityType pointing to the current value.

type AccessReviewApplyResult 

type AccessReviewApplyResult string

AccessReviewApplyResult - The outcome of applying the decision. 

const (
	AccessReviewApplyResultAppliedSuccessfully                  AccessReviewApplyResult = "AppliedSuccessfully"
	AccessReviewApplyResultAppliedSuccessfullyButObjectNotFound AccessReviewApplyResult = "AppliedSuccessfullyButObjectNotFound"
	AccessReviewApplyResultAppliedWithUnknownFailure            AccessReviewApplyResult = "AppliedWithUnknownFailure"
	AccessReviewApplyResultApplyNotSupported                    AccessReviewApplyResult = "ApplyNotSupported"
	AccessReviewApplyResultApplying                             AccessReviewApplyResult = "Applying"
	AccessReviewApplyResultNew                                  AccessReviewApplyResult = "New"
)

func PossibleAccessReviewApplyResultValues 

func PossibleAccessReviewApplyResultValues() []AccessReviewApplyResult

PossibleAccessReviewApplyResultValues returns the possible values for the AccessReviewApplyResult const type.

func (AccessReviewApplyResult) ToPtr 

func (c AccessReviewApplyResult) ToPtr() *AccessReviewApplyResult

ToPtr returns a *AccessReviewApplyResult pointing to the current value.

type AccessReviewDecision 

type AccessReviewDecision struct {
	// Access Review Decision properties.
	Properties *AccessReviewDecisionProperties `json:"properties,omitempty"`

	// READ-ONLY; The access review decision id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The access review decision name.
	Name *string `json:"name,omitempty" azure:"ro"`

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

AccessReviewDecision - Access Review.

type AccessReviewDecisionListResult 

type AccessReviewDecisionListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Access Review Decision list.
	Value []*AccessReviewDecision `json:"value,omitempty"`
}

AccessReviewDecisionListResult - List of access review decisions.

func (AccessReviewDecisionListResult) MarshalJSON 

func (a AccessReviewDecisionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewDecisionListResult.

type AccessReviewDecisionProperties 

type AccessReviewDecisionProperties struct {
	// The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny
	Decision *AccessReviewResult `json:"decision,omitempty"`

	// Justification provided by approvers for their action
	Justification *string `json:"justification,omitempty"`

	// READ-ONLY; Details of the applier.
	AppliedBy *AccessReviewActorIdentity `json:"appliedBy,omitempty" azure:"ro"`

	// READ-ONLY; The date and time when the review decision was applied.
	AppliedDateTime *time.Time `json:"appliedDateTime,omitempty" azure:"ro"`

	// READ-ONLY; The outcome of applying the decision.
	ApplyResult *AccessReviewApplyResult `json:"applyResult,omitempty" azure:"ro"`

	// READ-ONLY; The feature- generated recommendation shown to the reviewer.
	Recommendation *AccessRecommendationType `json:"recommendation,omitempty" azure:"ro"`

	// READ-ONLY; Details of the approver.
	ReviewedBy *AccessReviewActorIdentity `json:"reviewedBy,omitempty" azure:"ro"`

	// READ-ONLY; Date Time when a decision was taken.
	ReviewedDateTime *time.Time `json:"reviewedDateTime,omitempty" azure:"ro"`

	// READ-ONLY; Target of this decision record. Can be UserDecisionTarget or ServicePrincipalDecisionTarget
	Target AccessReviewDecisionTargetClassification `json:"target,omitempty" azure:"ro"`
}

AccessReviewDecisionProperties - Approval Step.

func (AccessReviewDecisionProperties) MarshalJSON 

func (a AccessReviewDecisionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewDecisionProperties.

func (*AccessReviewDecisionProperties) UnmarshalJSON 

func (a *AccessReviewDecisionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccessReviewDecisionProperties.

type AccessReviewDecisionTarget 

type AccessReviewDecisionTarget struct {
	// REQUIRED; The type of decision target : User/ServicePrincipal
	Type *DecisionTargetType `json:"type,omitempty"`
}

AccessReviewDecisionTarget - Target of the decision.

func (*AccessReviewDecisionTarget) GetAccessReviewDecisionTarget 

func (a *AccessReviewDecisionTarget) GetAccessReviewDecisionTarget() *AccessReviewDecisionTarget

GetAccessReviewDecisionTarget implements the AccessReviewDecisionTargetClassification interface for type AccessReviewDecisionTarget.

type AccessReviewDecisionTargetClassification 

type AccessReviewDecisionTargetClassification interface {
	// GetAccessReviewDecisionTarget returns the AccessReviewDecisionTarget content of the underlying type.
	GetAccessReviewDecisionTarget() *AccessReviewDecisionTarget
}

AccessReviewDecisionTargetClassification provides polymorphic access to related types. Call the interface's GetAccessReviewDecisionTarget() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AccessReviewDecisionTarget, *ServicePrincipalDecisionTarget, *UserDecisionTarget

type AccessReviewDefaultSettings 

type AccessReviewDefaultSettings struct {
	// Access Review properties.
	Properties *AccessReviewScheduleSettings `json:"properties,omitempty"`

	// READ-ONLY; The access review default settings id. This is only going to be default
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The access review default settings name. This is always going to be Access Review Default Settings
	Name *string `json:"name,omitempty" azure:"ro"`

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

AccessReviewDefaultSettings - Access Review Default Settings.

type AccessReviewDefaultSettingsClient 

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

AccessReviewDefaultSettingsClient contains the methods for the AccessReviewDefaultSettings group. Don't use this type directly, use NewAccessReviewDefaultSettingsClient() instead.

func NewAccessReviewDefaultSettingsClient 

func NewAccessReviewDefaultSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewDefaultSettingsClient

NewAccessReviewDefaultSettingsClient creates a new instance of AccessReviewDefaultSettingsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewDefaultSettingsClient) Get 

func (client *AccessReviewDefaultSettingsClient) Get(ctx context.Context, options *AccessReviewDefaultSettingsClientGetOptions) (AccessReviewDefaultSettingsClientGetResponse, error)

Get - Get access review default settings for the subscription If the operation fails it returns an *azcore.ResponseError type. options - AccessReviewDefaultSettingsClientGetOptions contains the optional parameters for the AccessReviewDefaultSettingsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewDefaultSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewDefaultSettingsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AccessReviewDefaultSettingsClientGetResult)
}

Output:

func (*AccessReviewDefaultSettingsClient) Put 

func (client *AccessReviewDefaultSettingsClient) Put(ctx context.Context, properties AccessReviewScheduleSettings, options *AccessReviewDefaultSettingsClientPutOptions) (AccessReviewDefaultSettingsClientPutResponse, error)

Put - Get access review default settings for the subscription If the operation fails it returns an *azcore.ResponseError type. properties - Access review schedule settings. options - AccessReviewDefaultSettingsClientPutOptions contains the optional parameters for the AccessReviewDefaultSettingsClient.Put method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/PutAccessReviewDefaultSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewDefaultSettingsClient("<subscription-id>", cred, nil)
	res, err := client.Put(ctx,
		armauthorization.AccessReviewScheduleSettings{},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AccessReviewDefaultSettingsClientPutResult)
}

Output:

type AccessReviewDefaultSettingsClientGetOptions added in v0.3.0 

type AccessReviewDefaultSettingsClientGetOptions struct {
}

AccessReviewDefaultSettingsClientGetOptions contains the optional parameters for the AccessReviewDefaultSettingsClient.Get method.

type AccessReviewDefaultSettingsClientGetResponse added in v0.3.0 

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

AccessReviewDefaultSettingsClientGetResponse contains the response from method AccessReviewDefaultSettingsClient.Get.

type AccessReviewDefaultSettingsClientGetResult added in v0.3.0 

type AccessReviewDefaultSettingsClientGetResult struct {
	AccessReviewDefaultSettings
}

AccessReviewDefaultSettingsClientGetResult contains the result from method AccessReviewDefaultSettingsClient.Get.

type AccessReviewDefaultSettingsClientPutOptions added in v0.3.0 

type AccessReviewDefaultSettingsClientPutOptions struct {
}

AccessReviewDefaultSettingsClientPutOptions contains the optional parameters for the AccessReviewDefaultSettingsClient.Put method.

type AccessReviewDefaultSettingsClientPutResponse added in v0.3.0 

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

AccessReviewDefaultSettingsClientPutResponse contains the response from method AccessReviewDefaultSettingsClient.Put.

type AccessReviewDefaultSettingsClientPutResult added in v0.3.0 

type AccessReviewDefaultSettingsClientPutResult struct {
	AccessReviewDefaultSettings
}

AccessReviewDefaultSettingsClientPutResult contains the result from method AccessReviewDefaultSettingsClient.Put.

type AccessReviewInstance 

type AccessReviewInstance struct {
	// Access Review properties.
	Properties *AccessReviewInstanceProperties `json:"properties,omitempty"`

	// READ-ONLY; The access review instance id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The access review instance name.
	Name *string `json:"name,omitempty" azure:"ro"`

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

AccessReviewInstance - Access Review Instance.

type AccessReviewInstanceClient 

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

AccessReviewInstanceClient contains the methods for the AccessReviewInstance group. Don't use this type directly, use NewAccessReviewInstanceClient() instead.

func NewAccessReviewInstanceClient 

func NewAccessReviewInstanceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewInstanceClient

NewAccessReviewInstanceClient creates a new instance of AccessReviewInstanceClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewInstanceClient) AcceptRecommendations 

func (client *AccessReviewInstanceClient) AcceptRecommendations(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstanceClientAcceptRecommendationsOptions) (AccessReviewInstanceClientAcceptRecommendationsResponse, error)

AcceptRecommendations - An action to accept recommendations for decision in an access review instance. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceClientAcceptRecommendationsOptions contains the optional parameters for the AccessReviewInstanceClient.AcceptRecommendations method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/AccessReviewInstanceAcceptRecommendations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceClient("<subscription-id>", cred, nil)
	_, err = client.AcceptRecommendations(ctx,
		"<schedule-definition-id>",
		"<id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*AccessReviewInstanceClient) ApplyDecisions 

func (client *AccessReviewInstanceClient) ApplyDecisions(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstanceClientApplyDecisionsOptions) (AccessReviewInstanceClientApplyDecisionsResponse, error)

ApplyDecisions - An action to apply all decisions for an access review instance. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceClientApplyDecisionsOptions contains the optional parameters for the AccessReviewInstanceClient.ApplyDecisions method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/AccessReviewInstanceApplyDecisions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceClient("<subscription-id>", cred, nil)
	_, err = client.ApplyDecisions(ctx,
		"<schedule-definition-id>",
		"<id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*AccessReviewInstanceClient) ResetDecisions 

func (client *AccessReviewInstanceClient) ResetDecisions(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstanceClientResetDecisionsOptions) (AccessReviewInstanceClientResetDecisionsResponse, error)

ResetDecisions - An action to reset all decisions for an access review instance. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceClientResetDecisionsOptions contains the optional parameters for the AccessReviewInstanceClient.ResetDecisions method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/AccessReviewInstanceResetDecisions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceClient("<subscription-id>", cred, nil)
	_, err = client.ResetDecisions(ctx,
		"<schedule-definition-id>",
		"<id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*AccessReviewInstanceClient) SendReminders 

func (client *AccessReviewInstanceClient) SendReminders(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstanceClientSendRemindersOptions) (AccessReviewInstanceClientSendRemindersResponse, error)

SendReminders - An action to send reminders for an access review instance. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceClientSendRemindersOptions contains the optional parameters for the AccessReviewInstanceClient.SendReminders method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/AccessReviewInstanceSendReminders.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceClient("<subscription-id>", cred, nil)
	_, err = client.SendReminders(ctx,
		"<schedule-definition-id>",
		"<id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*AccessReviewInstanceClient) Stop 

func (client *AccessReviewInstanceClient) Stop(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstanceClientStopOptions) (AccessReviewInstanceClientStopResponse, error)

Stop - An action to stop an access review instance. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceClientStopOptions contains the optional parameters for the AccessReviewInstanceClient.Stop method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/StopAccessReviewInstance.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceClient("<subscription-id>", cred, nil)
	_, err = client.Stop(ctx,
		"<schedule-definition-id>",
		"<id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type AccessReviewInstanceClientAcceptRecommendationsOptions added in v0.3.0 

type AccessReviewInstanceClientAcceptRecommendationsOptions struct {
}

AccessReviewInstanceClientAcceptRecommendationsOptions contains the optional parameters for the AccessReviewInstanceClient.AcceptRecommendations method.

type AccessReviewInstanceClientAcceptRecommendationsResponse added in v0.3.0 

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

AccessReviewInstanceClientAcceptRecommendationsResponse contains the response from method AccessReviewInstanceClient.AcceptRecommendations.

type AccessReviewInstanceClientApplyDecisionsOptions added in v0.3.0 

type AccessReviewInstanceClientApplyDecisionsOptions struct {
}

AccessReviewInstanceClientApplyDecisionsOptions contains the optional parameters for the AccessReviewInstanceClient.ApplyDecisions method.

type AccessReviewInstanceClientApplyDecisionsResponse added in v0.3.0 

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

AccessReviewInstanceClientApplyDecisionsResponse contains the response from method AccessReviewInstanceClient.ApplyDecisions.

type AccessReviewInstanceClientResetDecisionsOptions added in v0.3.0 

type AccessReviewInstanceClientResetDecisionsOptions struct {
}

AccessReviewInstanceClientResetDecisionsOptions contains the optional parameters for the AccessReviewInstanceClient.ResetDecisions method.

type AccessReviewInstanceClientResetDecisionsResponse added in v0.3.0 

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

AccessReviewInstanceClientResetDecisionsResponse contains the response from method AccessReviewInstanceClient.ResetDecisions.

type AccessReviewInstanceClientSendRemindersOptions added in v0.3.0 

type AccessReviewInstanceClientSendRemindersOptions struct {
}

AccessReviewInstanceClientSendRemindersOptions contains the optional parameters for the AccessReviewInstanceClient.SendReminders method.

type AccessReviewInstanceClientSendRemindersResponse added in v0.3.0 

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

AccessReviewInstanceClientSendRemindersResponse contains the response from method AccessReviewInstanceClient.SendReminders.

type AccessReviewInstanceClientStopOptions added in v0.3.0 

type AccessReviewInstanceClientStopOptions struct {
}

AccessReviewInstanceClientStopOptions contains the optional parameters for the AccessReviewInstanceClient.Stop method.

type AccessReviewInstanceClientStopResponse added in v0.3.0 

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

AccessReviewInstanceClientStopResponse contains the response from method AccessReviewInstanceClient.Stop.

type AccessReviewInstanceDecisionsClient 

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

AccessReviewInstanceDecisionsClient contains the methods for the AccessReviewInstanceDecisions group. Don't use this type directly, use NewAccessReviewInstanceDecisionsClient() instead.

func NewAccessReviewInstanceDecisionsClient 

func NewAccessReviewInstanceDecisionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewInstanceDecisionsClient

NewAccessReviewInstanceDecisionsClient creates a new instance of AccessReviewInstanceDecisionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewInstanceDecisionsClient) List 

func (client *AccessReviewInstanceDecisionsClient) List(scheduleDefinitionID string, id string, options *AccessReviewInstanceDecisionsClientListOptions) *AccessReviewInstanceDecisionsClientListPager

List - Get access review instance decisions If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceDecisionsClientListOptions contains the optional parameters for the AccessReviewInstanceDecisionsClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewInstanceDecisions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceDecisionsClient("<subscription-id>", cred, nil)
	pager := client.List("<schedule-definition-id>",
		"<id>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AccessReviewInstanceDecisionsClientListOptions added in v0.3.0 

type AccessReviewInstanceDecisionsClientListOptions struct {
}

AccessReviewInstanceDecisionsClientListOptions contains the optional parameters for the AccessReviewInstanceDecisionsClient.List method.

type AccessReviewInstanceDecisionsClientListPager added in v0.3.0 

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

AccessReviewInstanceDecisionsClientListPager provides operations for iterating over paged responses.

func (*AccessReviewInstanceDecisionsClientListPager) Err added in v0.3.0 

func (p *AccessReviewInstanceDecisionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AccessReviewInstanceDecisionsClientListPager) NextPage added in v0.3.0 

func (p *AccessReviewInstanceDecisionsClientListPager) 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 (*AccessReviewInstanceDecisionsClientListPager) PageResponse added in v0.3.0 

func (p *AccessReviewInstanceDecisionsClientListPager) PageResponse() AccessReviewInstanceDecisionsClientListResponse

PageResponse returns the current AccessReviewInstanceDecisionsClientListResponse page.

type AccessReviewInstanceDecisionsClientListResponse added in v0.3.0 

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

AccessReviewInstanceDecisionsClientListResponse contains the response from method AccessReviewInstanceDecisionsClient.List.

type AccessReviewInstanceDecisionsClientListResult added in v0.3.0 

type AccessReviewInstanceDecisionsClientListResult struct {
	AccessReviewDecisionListResult
}

AccessReviewInstanceDecisionsClientListResult contains the result from method AccessReviewInstanceDecisionsClient.List.

type AccessReviewInstanceListResult 

type AccessReviewInstanceListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Access Review Instance list.
	Value []*AccessReviewInstance `json:"value,omitempty"`
}

AccessReviewInstanceListResult - List of Access Review Instances.

func (AccessReviewInstanceListResult) MarshalJSON 

func (a AccessReviewInstanceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewInstanceListResult.

type AccessReviewInstanceMyDecisionsClient 

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

AccessReviewInstanceMyDecisionsClient contains the methods for the AccessReviewInstanceMyDecisions group. Don't use this type directly, use NewAccessReviewInstanceMyDecisionsClient() instead.

func NewAccessReviewInstanceMyDecisionsClient 

func NewAccessReviewInstanceMyDecisionsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewInstanceMyDecisionsClient

NewAccessReviewInstanceMyDecisionsClient creates a new instance of AccessReviewInstanceMyDecisionsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewInstanceMyDecisionsClient) GetByID 

func (client *AccessReviewInstanceMyDecisionsClient) GetByID(ctx context.Context, scheduleDefinitionID string, id string, decisionID string, options *AccessReviewInstanceMyDecisionsClientGetByIDOptions) (AccessReviewInstanceMyDecisionsClientGetByIDResponse, error)

GetByID - Get my single access review instance decision. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. decisionID - The id of the decision record. options - AccessReviewInstanceMyDecisionsClientGetByIDOptions contains the optional parameters for the AccessReviewInstanceMyDecisionsClient.GetByID method.

func (*AccessReviewInstanceMyDecisionsClient) List 

func (client *AccessReviewInstanceMyDecisionsClient) List(scheduleDefinitionID string, id string, options *AccessReviewInstanceMyDecisionsClientListOptions) *AccessReviewInstanceMyDecisionsClientListPager

List - Get my access review instance decisions. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstanceMyDecisionsClientListOptions contains the optional parameters for the AccessReviewInstanceMyDecisionsClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewInstanceMyDecisions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceMyDecisionsClient(cred, nil)
	pager := client.List("<schedule-definition-id>",
		"<id>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AccessReviewInstanceMyDecisionsClient) Patch 

func (client *AccessReviewInstanceMyDecisionsClient) Patch(ctx context.Context, scheduleDefinitionID string, id string, decisionID string, properties AccessReviewDecisionProperties, options *AccessReviewInstanceMyDecisionsClientPatchOptions) (AccessReviewInstanceMyDecisionsClientPatchResponse, error)

Patch - Record a decision. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. decisionID - The id of the decision record. properties - Access review decision properties to patch. options - AccessReviewInstanceMyDecisionsClientPatchOptions contains the optional parameters for the AccessReviewInstanceMyDecisionsClient.Patch method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/PatchAccessReviewInstanceMyDecisionById.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstanceMyDecisionsClient(cred, nil)
	res, err := client.Patch(ctx,
		"<schedule-definition-id>",
		"<id>",
		"<decision-id>",
		armauthorization.AccessReviewDecisionProperties{},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AccessReviewInstanceMyDecisionsClientPatchResult)
}

Output:

type AccessReviewInstanceMyDecisionsClientGetByIDOptions added in v0.3.0 

type AccessReviewInstanceMyDecisionsClientGetByIDOptions struct {
}

AccessReviewInstanceMyDecisionsClientGetByIDOptions contains the optional parameters for the AccessReviewInstanceMyDecisionsClient.GetByID method.

type AccessReviewInstanceMyDecisionsClientGetByIDResponse added in v0.3.0 

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

AccessReviewInstanceMyDecisionsClientGetByIDResponse contains the response from method AccessReviewInstanceMyDecisionsClient.GetByID.

type AccessReviewInstanceMyDecisionsClientGetByIDResult added in v0.3.0 

type AccessReviewInstanceMyDecisionsClientGetByIDResult struct {
	AccessReviewDecision
}

AccessReviewInstanceMyDecisionsClientGetByIDResult contains the result from method AccessReviewInstanceMyDecisionsClient.GetByID.

type AccessReviewInstanceMyDecisionsClientListOptions added in v0.3.0 

type AccessReviewInstanceMyDecisionsClientListOptions struct {
}

AccessReviewInstanceMyDecisionsClientListOptions contains the optional parameters for the AccessReviewInstanceMyDecisionsClient.List method.

type AccessReviewInstanceMyDecisionsClientListPager added in v0.3.0 

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

AccessReviewInstanceMyDecisionsClientListPager provides operations for iterating over paged responses.

func (*AccessReviewInstanceMyDecisionsClientListPager) Err added in v0.3.0 

func (p *AccessReviewInstanceMyDecisionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AccessReviewInstanceMyDecisionsClientListPager) NextPage added in v0.3.0 

func (p *AccessReviewInstanceMyDecisionsClientListPager) 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 (*AccessReviewInstanceMyDecisionsClientListPager) PageResponse added in v0.3.0 

func (p *AccessReviewInstanceMyDecisionsClientListPager) PageResponse() AccessReviewInstanceMyDecisionsClientListResponse

PageResponse returns the current AccessReviewInstanceMyDecisionsClientListResponse page.

type AccessReviewInstanceMyDecisionsClientListResponse added in v0.3.0 

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

AccessReviewInstanceMyDecisionsClientListResponse contains the response from method AccessReviewInstanceMyDecisionsClient.List.

type AccessReviewInstanceMyDecisionsClientListResult added in v0.3.0 

type AccessReviewInstanceMyDecisionsClientListResult struct {
	AccessReviewDecisionListResult
}

AccessReviewInstanceMyDecisionsClientListResult contains the result from method AccessReviewInstanceMyDecisionsClient.List.

type AccessReviewInstanceMyDecisionsClientPatchOptions added in v0.3.0 

type AccessReviewInstanceMyDecisionsClientPatchOptions struct {
}

AccessReviewInstanceMyDecisionsClientPatchOptions contains the optional parameters for the AccessReviewInstanceMyDecisionsClient.Patch method.

type AccessReviewInstanceMyDecisionsClientPatchResponse added in v0.3.0 

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

AccessReviewInstanceMyDecisionsClientPatchResponse contains the response from method AccessReviewInstanceMyDecisionsClient.Patch.

type AccessReviewInstanceMyDecisionsClientPatchResult added in v0.3.0 

type AccessReviewInstanceMyDecisionsClientPatchResult struct {
	AccessReviewDecision
}

AccessReviewInstanceMyDecisionsClientPatchResult contains the result from method AccessReviewInstanceMyDecisionsClient.Patch.

type AccessReviewInstanceProperties 

type AccessReviewInstanceProperties struct {
	// The DateTime when the review instance is scheduled to end.
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// The DateTime when the review instance is scheduled to be start.
	StartDateTime *time.Time `json:"startDateTime,omitempty"`

	// READ-ONLY; This read-only field specifies the status of an access review instance.
	Status *AccessReviewInstanceStatus `json:"status,omitempty" azure:"ro"`
}

AccessReviewInstanceProperties - Access Review Instance properties.

func (AccessReviewInstanceProperties) MarshalJSON 

func (a AccessReviewInstanceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewInstanceProperties.

func (*AccessReviewInstanceProperties) UnmarshalJSON 

func (a *AccessReviewInstanceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccessReviewInstanceProperties.

type AccessReviewInstanceStatus 

type AccessReviewInstanceStatus string

AccessReviewInstanceStatus - This read-only field specifies the status of an access review instance. 

const (
	AccessReviewInstanceStatusApplied       AccessReviewInstanceStatus = "Applied"
	AccessReviewInstanceStatusApplying      AccessReviewInstanceStatus = "Applying"
	AccessReviewInstanceStatusAutoReviewed  AccessReviewInstanceStatus = "AutoReviewed"
	AccessReviewInstanceStatusAutoReviewing AccessReviewInstanceStatus = "AutoReviewing"
	AccessReviewInstanceStatusCompleted     AccessReviewInstanceStatus = "Completed"
	AccessReviewInstanceStatusCompleting    AccessReviewInstanceStatus = "Completing"
	AccessReviewInstanceStatusInProgress    AccessReviewInstanceStatus = "InProgress"
	AccessReviewInstanceStatusInitializing  AccessReviewInstanceStatus = "Initializing"
	AccessReviewInstanceStatusNotStarted    AccessReviewInstanceStatus = "NotStarted"
	AccessReviewInstanceStatusScheduled     AccessReviewInstanceStatus = "Scheduled"
	AccessReviewInstanceStatusStarting      AccessReviewInstanceStatus = "Starting"
)

func PossibleAccessReviewInstanceStatusValues 

func PossibleAccessReviewInstanceStatusValues() []AccessReviewInstanceStatus

PossibleAccessReviewInstanceStatusValues returns the possible values for the AccessReviewInstanceStatus const type.

func (AccessReviewInstanceStatus) ToPtr 

func (c AccessReviewInstanceStatus) ToPtr() *AccessReviewInstanceStatus

ToPtr returns a *AccessReviewInstanceStatus pointing to the current value.

type AccessReviewInstancesAssignedForMyApprovalClient 

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

AccessReviewInstancesAssignedForMyApprovalClient contains the methods for the AccessReviewInstancesAssignedForMyApproval group. Don't use this type directly, use NewAccessReviewInstancesAssignedForMyApprovalClient() instead.

func NewAccessReviewInstancesAssignedForMyApprovalClient 

func NewAccessReviewInstancesAssignedForMyApprovalClient(credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewInstancesAssignedForMyApprovalClient

NewAccessReviewInstancesAssignedForMyApprovalClient creates a new instance of AccessReviewInstancesAssignedForMyApprovalClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewInstancesAssignedForMyApprovalClient) GetByID 

func (client *AccessReviewInstancesAssignedForMyApprovalClient) GetByID(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstancesAssignedForMyApprovalClientGetByIDOptions) (AccessReviewInstancesAssignedForMyApprovalClientGetByIDResponse, error)

GetByID - Get single access review instance assigned for my approval. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstancesAssignedForMyApprovalClientGetByIDOptions contains the optional parameters for the AccessReviewInstancesAssignedForMyApprovalClient.GetByID method.

func (*AccessReviewInstancesAssignedForMyApprovalClient) List 

func (client *AccessReviewInstancesAssignedForMyApprovalClient) List(scheduleDefinitionID string, options *AccessReviewInstancesAssignedForMyApprovalClientListOptions) *AccessReviewInstancesAssignedForMyApprovalClientListPager

List - Get access review instances assigned for my approval. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. options - AccessReviewInstancesAssignedForMyApprovalClientListOptions contains the optional parameters for the AccessReviewInstancesAssignedForMyApprovalClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstancesAssignedForMyApprovalClient(cred, nil)
	pager := client.List("<schedule-definition-id>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AccessReviewInstancesAssignedForMyApprovalClientGetByIDOptions added in v0.3.0 

type AccessReviewInstancesAssignedForMyApprovalClientGetByIDOptions struct {
}

AccessReviewInstancesAssignedForMyApprovalClientGetByIDOptions contains the optional parameters for the AccessReviewInstancesAssignedForMyApprovalClient.GetByID method.

type AccessReviewInstancesAssignedForMyApprovalClientGetByIDResponse added in v0.3.0 

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

AccessReviewInstancesAssignedForMyApprovalClientGetByIDResponse contains the response from method AccessReviewInstancesAssignedForMyApprovalClient.GetByID.

type AccessReviewInstancesAssignedForMyApprovalClientGetByIDResult added in v0.3.0 

type AccessReviewInstancesAssignedForMyApprovalClientGetByIDResult struct {
	AccessReviewInstance
}

AccessReviewInstancesAssignedForMyApprovalClientGetByIDResult contains the result from method AccessReviewInstancesAssignedForMyApprovalClient.GetByID.

type AccessReviewInstancesAssignedForMyApprovalClientListOptions added in v0.3.0 

type AccessReviewInstancesAssignedForMyApprovalClientListOptions struct {
}

AccessReviewInstancesAssignedForMyApprovalClientListOptions contains the optional parameters for the AccessReviewInstancesAssignedForMyApprovalClient.List method.

type AccessReviewInstancesAssignedForMyApprovalClientListPager added in v0.3.0 

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

AccessReviewInstancesAssignedForMyApprovalClientListPager provides operations for iterating over paged responses.

func (*AccessReviewInstancesAssignedForMyApprovalClientListPager) Err added in v0.3.0 

func (p *AccessReviewInstancesAssignedForMyApprovalClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AccessReviewInstancesAssignedForMyApprovalClientListPager) NextPage added in v0.3.0 

func (p *AccessReviewInstancesAssignedForMyApprovalClientListPager) 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 (*AccessReviewInstancesAssignedForMyApprovalClientListPager) PageResponse added in v0.3.0 

func (p *AccessReviewInstancesAssignedForMyApprovalClientListPager) PageResponse() AccessReviewInstancesAssignedForMyApprovalClientListResponse

PageResponse returns the current AccessReviewInstancesAssignedForMyApprovalClientListResponse page.

type AccessReviewInstancesAssignedForMyApprovalClientListResponse added in v0.3.0 

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

AccessReviewInstancesAssignedForMyApprovalClientListResponse contains the response from method AccessReviewInstancesAssignedForMyApprovalClient.List.

type AccessReviewInstancesAssignedForMyApprovalClientListResult added in v0.3.0 

type AccessReviewInstancesAssignedForMyApprovalClientListResult struct {
	AccessReviewInstanceListResult
}

AccessReviewInstancesAssignedForMyApprovalClientListResult contains the result from method AccessReviewInstancesAssignedForMyApprovalClient.List.

type AccessReviewInstancesClient 

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

AccessReviewInstancesClient contains the methods for the AccessReviewInstances group. Don't use this type directly, use NewAccessReviewInstancesClient() instead.

func NewAccessReviewInstancesClient 

func NewAccessReviewInstancesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewInstancesClient

NewAccessReviewInstancesClient creates a new instance of AccessReviewInstancesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewInstancesClient) GetByID 

func (client *AccessReviewInstancesClient) GetByID(ctx context.Context, scheduleDefinitionID string, id string, options *AccessReviewInstancesClientGetByIDOptions) (AccessReviewInstancesClientGetByIDResponse, error)

GetByID - Get access review instances If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. id - The id of the access review instance. options - AccessReviewInstancesClientGetByIDOptions contains the optional parameters for the AccessReviewInstancesClient.GetByID method.

func (*AccessReviewInstancesClient) List 

func (client *AccessReviewInstancesClient) List(scheduleDefinitionID string, options *AccessReviewInstancesClientListOptions) *AccessReviewInstancesClientListPager

List - Get access review instances If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. options - AccessReviewInstancesClientListOptions contains the optional parameters for the AccessReviewInstancesClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewInstances.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewInstancesClient("<subscription-id>", cred, nil)
	pager := client.List("<schedule-definition-id>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AccessReviewInstancesClientGetByIDOptions added in v0.3.0 

type AccessReviewInstancesClientGetByIDOptions struct {
}

AccessReviewInstancesClientGetByIDOptions contains the optional parameters for the AccessReviewInstancesClient.GetByID method.

type AccessReviewInstancesClientGetByIDResponse added in v0.3.0 

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

AccessReviewInstancesClientGetByIDResponse contains the response from method AccessReviewInstancesClient.GetByID.

type AccessReviewInstancesClientGetByIDResult added in v0.3.0 

type AccessReviewInstancesClientGetByIDResult struct {
	AccessReviewInstance
}

AccessReviewInstancesClientGetByIDResult contains the result from method AccessReviewInstancesClient.GetByID.

type AccessReviewInstancesClientListOptions added in v0.3.0 

type AccessReviewInstancesClientListOptions struct {
}

AccessReviewInstancesClientListOptions contains the optional parameters for the AccessReviewInstancesClient.List method.

type AccessReviewInstancesClientListPager added in v0.3.0 

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

AccessReviewInstancesClientListPager provides operations for iterating over paged responses.

func (*AccessReviewInstancesClientListPager) Err added in v0.3.0 

func (p *AccessReviewInstancesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AccessReviewInstancesClientListPager) NextPage added in v0.3.0 

func (p *AccessReviewInstancesClientListPager) 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 (*AccessReviewInstancesClientListPager) PageResponse added in v0.3.0 

func (p *AccessReviewInstancesClientListPager) PageResponse() AccessReviewInstancesClientListResponse

PageResponse returns the current AccessReviewInstancesClientListResponse page.

type AccessReviewInstancesClientListResponse added in v0.3.0 

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

AccessReviewInstancesClientListResponse contains the response from method AccessReviewInstancesClient.List.

type AccessReviewInstancesClientListResult added in v0.3.0 

type AccessReviewInstancesClientListResult struct {
	AccessReviewInstanceListResult
}

AccessReviewInstancesClientListResult contains the result from method AccessReviewInstancesClient.List.

type AccessReviewRecurrencePattern 

type AccessReviewRecurrencePattern struct {
	// The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
	Interval *int32 `json:"interval,omitempty"`

	// The recurrence type : weekly, monthly, etc.
	Type *AccessReviewRecurrencePatternType `json:"type,omitempty"`
}

AccessReviewRecurrencePattern - Recurrence Pattern of an Access Review Schedule Definition.

type AccessReviewRecurrencePatternType 

type AccessReviewRecurrencePatternType string

AccessReviewRecurrencePatternType - The recurrence type : weekly, monthly, etc. 

const (
	AccessReviewRecurrencePatternTypeAbsoluteMonthly AccessReviewRecurrencePatternType = "absoluteMonthly"
	AccessReviewRecurrencePatternTypeWeekly          AccessReviewRecurrencePatternType = "weekly"
)

func PossibleAccessReviewRecurrencePatternTypeValues 

func PossibleAccessReviewRecurrencePatternTypeValues() []AccessReviewRecurrencePatternType

PossibleAccessReviewRecurrencePatternTypeValues returns the possible values for the AccessReviewRecurrencePatternType const type.

func (AccessReviewRecurrencePatternType) ToPtr 

func (c AccessReviewRecurrencePatternType) ToPtr() *AccessReviewRecurrencePatternType

ToPtr returns a *AccessReviewRecurrencePatternType pointing to the current value.

type AccessReviewRecurrenceRange 

type AccessReviewRecurrenceRange struct {
	// The DateTime when the review is scheduled to end. Required if type is endDate
	EndDate *time.Time `json:"endDate,omitempty"`

	// The number of times to repeat the access review. Required and must be positive if type is numbered.
	NumberOfOccurrences *int32 `json:"numberOfOccurrences,omitempty"`

	// The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
	StartDate *time.Time `json:"startDate,omitempty"`

	// The recurrence range type. The possible values are: endDate, noEnd, numbered.
	Type *AccessReviewRecurrenceRangeType `json:"type,omitempty"`
}

AccessReviewRecurrenceRange - Recurrence Range of an Access Review Schedule Definition.

func (AccessReviewRecurrenceRange) MarshalJSON 

func (a AccessReviewRecurrenceRange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewRecurrenceRange.

func (*AccessReviewRecurrenceRange) UnmarshalJSON 

func (a *AccessReviewRecurrenceRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccessReviewRecurrenceRange.

type AccessReviewRecurrenceRangeType 

type AccessReviewRecurrenceRangeType string

AccessReviewRecurrenceRangeType - The recurrence range type. The possible values are: endDate, noEnd, numbered. 

const (
	AccessReviewRecurrenceRangeTypeEndDate  AccessReviewRecurrenceRangeType = "endDate"
	AccessReviewRecurrenceRangeTypeNoEnd    AccessReviewRecurrenceRangeType = "noEnd"
	AccessReviewRecurrenceRangeTypeNumbered AccessReviewRecurrenceRangeType = "numbered"
)

func PossibleAccessReviewRecurrenceRangeTypeValues 

func PossibleAccessReviewRecurrenceRangeTypeValues() []AccessReviewRecurrenceRangeType

PossibleAccessReviewRecurrenceRangeTypeValues returns the possible values for the AccessReviewRecurrenceRangeType const type.

func (AccessReviewRecurrenceRangeType) ToPtr 

func (c AccessReviewRecurrenceRangeType) ToPtr() *AccessReviewRecurrenceRangeType

ToPtr returns a *AccessReviewRecurrenceRangeType pointing to the current value.

type AccessReviewRecurrenceSettings 

type AccessReviewRecurrenceSettings struct {
	// Access Review schedule definition recurrence pattern.
	Pattern *AccessReviewRecurrencePattern `json:"pattern,omitempty"`

	// Access Review schedule definition recurrence range.
	Range *AccessReviewRecurrenceRange `json:"range,omitempty"`
}

AccessReviewRecurrenceSettings - Recurrence Settings of an Access Review Schedule Definition.

type AccessReviewResult 

type AccessReviewResult string

AccessReviewResult - The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny 

const (
	AccessReviewResultApprove     AccessReviewResult = "Approve"
	AccessReviewResultDeny        AccessReviewResult = "Deny"
	AccessReviewResultDontKnow    AccessReviewResult = "DontKnow"
	AccessReviewResultNotNotified AccessReviewResult = "NotNotified"
	AccessReviewResultNotReviewed AccessReviewResult = "NotReviewed"
)

func PossibleAccessReviewResultValues 

func PossibleAccessReviewResultValues() []AccessReviewResult

PossibleAccessReviewResultValues returns the possible values for the AccessReviewResult const type.

func (AccessReviewResult) ToPtr 

func (c AccessReviewResult) ToPtr() *AccessReviewResult

ToPtr returns a *AccessReviewResult pointing to the current value.

type AccessReviewReviewer 

type AccessReviewReviewer struct {
	// The id of the reviewer(user/servicePrincipal)
	PrincipalID *string `json:"principalId,omitempty"`

	// READ-ONLY; The identity type : user/servicePrincipal
	PrincipalType *AccessReviewReviewerType `json:"principalType,omitempty" azure:"ro"`
}

AccessReviewReviewer - Descriptor for what needs to be reviewed

type AccessReviewReviewerType 

type AccessReviewReviewerType string

AccessReviewReviewerType - The identity type : user/servicePrincipal 

const (
	AccessReviewReviewerTypeServicePrincipal AccessReviewReviewerType = "servicePrincipal"
	AccessReviewReviewerTypeUser             AccessReviewReviewerType = "user"
)

func PossibleAccessReviewReviewerTypeValues 

func PossibleAccessReviewReviewerTypeValues() []AccessReviewReviewerType

PossibleAccessReviewReviewerTypeValues returns the possible values for the AccessReviewReviewerType const type.

func (AccessReviewReviewerType) ToPtr 

func (c AccessReviewReviewerType) ToPtr() *AccessReviewReviewerType

ToPtr returns a *AccessReviewReviewerType pointing to the current value.

type AccessReviewScheduleDefinition 

type AccessReviewScheduleDefinition struct {
	// Access Review properties.
	Properties *AccessReviewScheduleDefinitionProperties `json:"properties,omitempty"`

	// READ-ONLY; The access review schedule definition id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The access review schedule definition unique id.
	Name *string `json:"name,omitempty" azure:"ro"`

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

AccessReviewScheduleDefinition - Access Review Schedule Definition.

type AccessReviewScheduleDefinitionListResult 

type AccessReviewScheduleDefinitionListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Access Review Schedule Definition list.
	Value []*AccessReviewScheduleDefinition `json:"value,omitempty"`
}

AccessReviewScheduleDefinitionListResult - List of Access Review Schedule Definitions.

func (AccessReviewScheduleDefinitionListResult) MarshalJSON 

func (a AccessReviewScheduleDefinitionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewScheduleDefinitionListResult.

type AccessReviewScheduleDefinitionProperties 

type AccessReviewScheduleDefinitionProperties struct {
	// The description provided by the access review creator and visible to admins.
	DescriptionForAdmins *string `json:"descriptionForAdmins,omitempty"`

	// The description provided by the access review creator to be shown to reviewers.
	DescriptionForReviewers *string `json:"descriptionForReviewers,omitempty"`

	// The display name for the schedule definition.
	DisplayName *string `json:"displayName,omitempty"`

	// This is the collection of instances returned when one does an expand on it.
	Instances []*AccessReviewInstance `json:"instances,omitempty"`

	// This is the collection of reviewers.
	Reviewers []*AccessReviewReviewer `json:"reviewers,omitempty"`

	// Access Review Settings.
	Settings *AccessReviewScheduleSettings `json:"settings,omitempty"`

	// READ-ONLY; The user or other identity who created this review.
	CreatedBy *AccessReviewActorIdentity `json:"createdBy,omitempty" azure:"ro"`

	// READ-ONLY; This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned.
	// However, in some cases, the reviewers may not be assigned and instead be chosen
	// dynamically. For example managers review or self review.
	ReviewersType *AccessReviewScheduleDefinitionReviewersType `json:"reviewersType,omitempty" azure:"ro"`

	// READ-ONLY; This is used to define what to include in scope of the review. The scope definition includes the resourceId
	// and roleDefinitionId.
	Scope *AccessReviewScope `json:"scope,omitempty" azure:"ro"`

	// READ-ONLY; This read-only field specifies the status of an accessReview.
	Status *AccessReviewScheduleDefinitionStatus `json:"status,omitempty" azure:"ro"`
}

AccessReviewScheduleDefinitionProperties - Access Review.

func (AccessReviewScheduleDefinitionProperties) MarshalJSON 

func (a AccessReviewScheduleDefinitionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessReviewScheduleDefinitionProperties.

type AccessReviewScheduleDefinitionReviewersType 

type AccessReviewScheduleDefinitionReviewersType string

AccessReviewScheduleDefinitionReviewersType - This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. 

const (
	AccessReviewScheduleDefinitionReviewersTypeAssigned AccessReviewScheduleDefinitionReviewersType = "Assigned"
	AccessReviewScheduleDefinitionReviewersTypeManagers AccessReviewScheduleDefinitionReviewersType = "Managers"
	AccessReviewScheduleDefinitionReviewersTypeSelf     AccessReviewScheduleDefinitionReviewersType = "Self"
)

func PossibleAccessReviewScheduleDefinitionReviewersTypeValues 

func PossibleAccessReviewScheduleDefinitionReviewersTypeValues() []AccessReviewScheduleDefinitionReviewersType

PossibleAccessReviewScheduleDefinitionReviewersTypeValues returns the possible values for the AccessReviewScheduleDefinitionReviewersType const type.

func (AccessReviewScheduleDefinitionReviewersType) ToPtr 

func (c AccessReviewScheduleDefinitionReviewersType) ToPtr() *AccessReviewScheduleDefinitionReviewersType

ToPtr returns a *AccessReviewScheduleDefinitionReviewersType pointing to the current value.

type AccessReviewScheduleDefinitionStatus 

type AccessReviewScheduleDefinitionStatus string

AccessReviewScheduleDefinitionStatus - This read-only field specifies the status of an accessReview. 

const (
	AccessReviewScheduleDefinitionStatusApplied       AccessReviewScheduleDefinitionStatus = "Applied"
	AccessReviewScheduleDefinitionStatusApplying      AccessReviewScheduleDefinitionStatus = "Applying"
	AccessReviewScheduleDefinitionStatusAutoReviewed  AccessReviewScheduleDefinitionStatus = "AutoReviewed"
	AccessReviewScheduleDefinitionStatusAutoReviewing AccessReviewScheduleDefinitionStatus = "AutoReviewing"
	AccessReviewScheduleDefinitionStatusCompleted     AccessReviewScheduleDefinitionStatus = "Completed"
	AccessReviewScheduleDefinitionStatusCompleting    AccessReviewScheduleDefinitionStatus = "Completing"
	AccessReviewScheduleDefinitionStatusInProgress    AccessReviewScheduleDefinitionStatus = "InProgress"
	AccessReviewScheduleDefinitionStatusInitializing  AccessReviewScheduleDefinitionStatus = "Initializing"
	AccessReviewScheduleDefinitionStatusNotStarted    AccessReviewScheduleDefinitionStatus = "NotStarted"
	AccessReviewScheduleDefinitionStatusScheduled     AccessReviewScheduleDefinitionStatus = "Scheduled"
	AccessReviewScheduleDefinitionStatusStarting      AccessReviewScheduleDefinitionStatus = "Starting"
)

func PossibleAccessReviewScheduleDefinitionStatusValues 

func PossibleAccessReviewScheduleDefinitionStatusValues() []AccessReviewScheduleDefinitionStatus

PossibleAccessReviewScheduleDefinitionStatusValues returns the possible values for the AccessReviewScheduleDefinitionStatus const type.

func (AccessReviewScheduleDefinitionStatus) ToPtr 

func (c AccessReviewScheduleDefinitionStatus) ToPtr() *AccessReviewScheduleDefinitionStatus

ToPtr returns a *AccessReviewScheduleDefinitionStatus pointing to the current value.

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClient 

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

AccessReviewScheduleDefinitionsAssignedForMyApprovalClient contains the methods for the AccessReviewScheduleDefinitionsAssignedForMyApproval group. Don't use this type directly, use NewAccessReviewScheduleDefinitionsAssignedForMyApprovalClient() instead.

func NewAccessReviewScheduleDefinitionsAssignedForMyApprovalClient 

func NewAccessReviewScheduleDefinitionsAssignedForMyApprovalClient(credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewScheduleDefinitionsAssignedForMyApprovalClient

NewAccessReviewScheduleDefinitionsAssignedForMyApprovalClient creates a new instance of AccessReviewScheduleDefinitionsAssignedForMyApprovalClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewScheduleDefinitionsAssignedForMyApprovalClient) List 

func (client *AccessReviewScheduleDefinitionsAssignedForMyApprovalClient) List(options *AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListOptions) *AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager

List - Get access review instances assigned for my approval. If the operation fails it returns an *azcore.ResponseError type. options - AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListOptions contains the optional parameters for the AccessReviewScheduleDefinitionsAssignedForMyApprovalClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewScheduleDefinitionsAssignedForMyApprovalClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListOptions added in v0.3.0 

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListOptions struct {
}

AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListOptions contains the optional parameters for the AccessReviewScheduleDefinitionsAssignedForMyApprovalClient.List method.

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager added in v0.3.0 

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

AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager provides operations for iterating over paged responses.

func (*AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager) Err added in v0.3.0 

func (p *AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager) NextPage added in v0.3.0 

func (p *AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager) 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 (*AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager) PageResponse added in v0.3.0 

func (p *AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListPager) PageResponse() AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResponse

PageResponse returns the current AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResponse page.

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResponse added in v0.3.0 

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

AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResponse contains the response from method AccessReviewScheduleDefinitionsAssignedForMyApprovalClient.List.

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResult added in v0.3.0 

type AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResult struct {
	AccessReviewScheduleDefinitionListResult
}

AccessReviewScheduleDefinitionsAssignedForMyApprovalClientListResult contains the result from method AccessReviewScheduleDefinitionsAssignedForMyApprovalClient.List.

type AccessReviewScheduleDefinitionsClient 

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

AccessReviewScheduleDefinitionsClient contains the methods for the AccessReviewScheduleDefinitions group. Don't use this type directly, use NewAccessReviewScheduleDefinitionsClient() instead.

func NewAccessReviewScheduleDefinitionsClient 

func NewAccessReviewScheduleDefinitionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AccessReviewScheduleDefinitionsClient

NewAccessReviewScheduleDefinitionsClient creates a new instance of AccessReviewScheduleDefinitionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessReviewScheduleDefinitionsClient) CreateOrUpdateByID 

func (client *AccessReviewScheduleDefinitionsClient) CreateOrUpdateByID(ctx context.Context, scheduleDefinitionID string, properties AccessReviewScheduleDefinitionProperties, options *AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDOptions) (AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDResponse, error)

CreateOrUpdateByID - Create or Update access review schedule definition. If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. properties - Access review schedule definition properties. options - AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.CreateOrUpdateByID method.

func (*AccessReviewScheduleDefinitionsClient) DeleteByID 

func (client *AccessReviewScheduleDefinitionsClient) DeleteByID(ctx context.Context, scheduleDefinitionID string, options *AccessReviewScheduleDefinitionsClientDeleteByIDOptions) (AccessReviewScheduleDefinitionsClientDeleteByIDResponse, error)

DeleteByID - Delete access review schedule definition If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. options - AccessReviewScheduleDefinitionsClientDeleteByIDOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.DeleteByID method.

func (*AccessReviewScheduleDefinitionsClient) GetByID 

func (client *AccessReviewScheduleDefinitionsClient) GetByID(ctx context.Context, scheduleDefinitionID string, options *AccessReviewScheduleDefinitionsClientGetByIDOptions) (AccessReviewScheduleDefinitionsClientGetByIDResponse, error)

GetByID - Get single access review definition If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. options - AccessReviewScheduleDefinitionsClientGetByIDOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.GetByID method.

func (*AccessReviewScheduleDefinitionsClient) List 

func (client *AccessReviewScheduleDefinitionsClient) List(options *AccessReviewScheduleDefinitionsClientListOptions) *AccessReviewScheduleDefinitionsClientListPager

List - Get access review schedule definitions If the operation fails it returns an *azcore.ResponseError type. options - AccessReviewScheduleDefinitionsClientListOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/GetAccessReviewScheduleDefinitions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewScheduleDefinitionsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AccessReviewScheduleDefinitionsClient) Stop 

func (client *AccessReviewScheduleDefinitionsClient) Stop(ctx context.Context, scheduleDefinitionID string, options *AccessReviewScheduleDefinitionsClientStopOptions) (AccessReviewScheduleDefinitionsClientStopResponse, error)

Stop - Stop access review definition If the operation fails it returns an *azcore.ResponseError type. scheduleDefinitionID - The id of the access review schedule definition. options - AccessReviewScheduleDefinitionsClientStopOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.Stop method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/examples/StopAccessReviewScheduleDefinition.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewAccessReviewScheduleDefinitionsClient("<subscription-id>", cred, nil)
	_, err = client.Stop(ctx,
		"<schedule-definition-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDOptions added in v0.3.0 

type AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDOptions struct {
}

AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.CreateOrUpdateByID method.

type AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDResponse added in v0.3.0 

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

AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDResponse contains the response from method AccessReviewScheduleDefinitionsClient.CreateOrUpdateByID.

type AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDResult added in v0.3.0 

type AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDResult struct {
	AccessReviewScheduleDefinition
}

AccessReviewScheduleDefinitionsClientCreateOrUpdateByIDResult contains the result from method AccessReviewScheduleDefinitionsClient.CreateOrUpdateByID.

type AccessReviewScheduleDefinitionsClientDeleteByIDOptions added in v0.3.0 

type AccessReviewScheduleDefinitionsClientDeleteByIDOptions struct {
}

AccessReviewScheduleDefinitionsClientDeleteByIDOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.DeleteByID method.

type AccessReviewScheduleDefinitionsClientDeleteByIDResponse added in v0.3.0 

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

AccessReviewScheduleDefinitionsClientDeleteByIDResponse contains the response from method AccessReviewScheduleDefinitionsClient.DeleteByID.

type AccessReviewScheduleDefinitionsClientGetByIDOptions added in v0.3.0 

type AccessReviewScheduleDefinitionsClientGetByIDOptions struct {
}

AccessReviewScheduleDefinitionsClientGetByIDOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.GetByID method.

type AccessReviewScheduleDefinitionsClientGetByIDResponse added in v0.3.0 

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

AccessReviewScheduleDefinitionsClientGetByIDResponse contains the response from method AccessReviewScheduleDefinitionsClient.GetByID.

type AccessReviewScheduleDefinitionsClientGetByIDResult added in v0.3.0 

type AccessReviewScheduleDefinitionsClientGetByIDResult struct {
	AccessReviewScheduleDefinition
}

AccessReviewScheduleDefinitionsClientGetByIDResult contains the result from method AccessReviewScheduleDefinitionsClient.GetByID.

type AccessReviewScheduleDefinitionsClientListOptions added in v0.3.0 

type AccessReviewScheduleDefinitionsClientListOptions struct {
}

AccessReviewScheduleDefinitionsClientListOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.List method.

type AccessReviewScheduleDefinitionsClientListPager added in v0.3.0 

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

AccessReviewScheduleDefinitionsClientListPager provides operations for iterating over paged responses.

func (*AccessReviewScheduleDefinitionsClientListPager) Err added in v0.3.0 

func (p *AccessReviewScheduleDefinitionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AccessReviewScheduleDefinitionsClientListPager) NextPage added in v0.3.0 

func (p *AccessReviewScheduleDefinitionsClientListPager) 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 (*AccessReviewScheduleDefinitionsClientListPager) PageResponse added in v0.3.0 

func (p *AccessReviewScheduleDefinitionsClientListPager) PageResponse() AccessReviewScheduleDefinitionsClientListResponse

PageResponse returns the current AccessReviewScheduleDefinitionsClientListResponse page.

type AccessReviewScheduleDefinitionsClientListResponse added in v0.3.0 

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

AccessReviewScheduleDefinitionsClientListResponse contains the response from method AccessReviewScheduleDefinitionsClient.List.

type AccessReviewScheduleDefinitionsClientListResult added in v0.3.0 

type AccessReviewScheduleDefinitionsClientListResult struct {
	AccessReviewScheduleDefinitionListResult
}

AccessReviewScheduleDefinitionsClientListResult contains the result from method AccessReviewScheduleDefinitionsClient.List.

type AccessReviewScheduleDefinitionsClientStopOptions added in v0.3.0 

type AccessReviewScheduleDefinitionsClientStopOptions struct {
}

AccessReviewScheduleDefinitionsClientStopOptions contains the optional parameters for the AccessReviewScheduleDefinitionsClient.Stop method.

type AccessReviewScheduleDefinitionsClientStopResponse added in v0.3.0 

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

AccessReviewScheduleDefinitionsClientStopResponse contains the response from method AccessReviewScheduleDefinitionsClient.Stop.

type AccessReviewScheduleSettings 

type AccessReviewScheduleSettings struct {
	// Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled.
	// If not enabled, a user must, after the review completes, apply the access review.
	AutoApplyDecisionsEnabled *bool `json:"autoApplyDecisionsEnabled,omitempty"`

	// This specifies the behavior for the autoReview feature when an access review completes.
	DefaultDecision *DefaultDecisionType `json:"defaultDecision,omitempty"`

	// Flag to indicate whether reviewers are required to provide a justification when reviewing access.
	DefaultDecisionEnabled *bool `json:"defaultDecisionEnabled,omitempty"`

	// The duration in days for an instance.
	InstanceDurationInDays *int32 `json:"instanceDurationInDays,omitempty"`

	// Flag to indicate whether the reviewer is required to pass justification when recording a decision.
	JustificationRequiredOnApproval *bool `json:"justificationRequiredOnApproval,omitempty"`

	// Flag to indicate whether sending mails to reviewers and the review creator is enabled.
	MailNotificationsEnabled *bool `json:"mailNotificationsEnabled,omitempty"`

	// Flag to indicate whether showing recommendations to reviewers is enabled.
	RecommendationsEnabled *bool `json:"recommendationsEnabled,omitempty"`

	// Access Review Settings.
	Recurrence *AccessReviewRecurrenceSettings `json:"recurrence,omitempty"`

	// Flag to indicate whether sending reminder emails to reviewers are enabled.
	ReminderNotificationsEnabled *bool `json:"reminderNotificationsEnabled,omitempty"`
}

AccessReviewScheduleSettings - Settings of an Access Review.

type AccessReviewScope 

type AccessReviewScope struct {
	// READ-ONLY; The identity type user/servicePrincipal to review
	PrincipalType *AccessReviewScopePrincipalType `json:"principalType,omitempty" azure:"ro"`

	// READ-ONLY; ResourceId in which this review is getting created
	ResourceID *string `json:"resourceId,omitempty" azure:"ro"`

	// READ-ONLY; This is used to indicate the role being reviewed
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty" azure:"ro"`
}

AccessReviewScope - Descriptor for what needs to be reviewed

type AccessReviewScopePrincipalType 

type AccessReviewScopePrincipalType string

AccessReviewScopePrincipalType - The identity type user/servicePrincipal to review 

const (
	AccessReviewScopePrincipalTypeServicePrincipal AccessReviewScopePrincipalType = "servicePrincipal"
	AccessReviewScopePrincipalTypeUser             AccessReviewScopePrincipalType = "user"
)

func PossibleAccessReviewScopePrincipalTypeValues 

func PossibleAccessReviewScopePrincipalTypeValues() []AccessReviewScopePrincipalType

PossibleAccessReviewScopePrincipalTypeValues returns the possible values for the AccessReviewScopePrincipalType const type.

func (AccessReviewScopePrincipalType) ToPtr 

func (c AccessReviewScopePrincipalType) ToPtr() *AccessReviewScopePrincipalType

ToPtr returns a *AccessReviewScopePrincipalType pointing to the current value.

type ApprovalMode 

type ApprovalMode string

ApprovalMode - The type of rule 

const (
	ApprovalModeNoApproval  ApprovalMode = "NoApproval"
	ApprovalModeParallel    ApprovalMode = "Parallel"
	ApprovalModeSerial      ApprovalMode = "Serial"
	ApprovalModeSingleStage ApprovalMode = "SingleStage"
)

func PossibleApprovalModeValues 

func PossibleApprovalModeValues() []ApprovalMode

PossibleApprovalModeValues returns the possible values for the ApprovalMode const type.

func (ApprovalMode) ToPtr 

func (c ApprovalMode) ToPtr() *ApprovalMode

ToPtr returns a *ApprovalMode pointing to the current value.

type ApprovalSettings 

type ApprovalSettings struct {
	// The type of rule
	ApprovalMode *ApprovalMode `json:"approvalMode,omitempty"`

	// The approval stages of the request.
	ApprovalStages []*ApprovalStage `json:"approvalStages,omitempty"`

	// Determine whether approval is required or not.
	IsApprovalRequired *bool `json:"isApprovalRequired,omitempty"`

	// Determine whether approval is required for assignment extension.
	IsApprovalRequiredForExtension *bool `json:"isApprovalRequiredForExtension,omitempty"`

	// Determine whether requestor justification required.
	IsRequestorJustificationRequired *bool `json:"isRequestorJustificationRequired,omitempty"`
}

ApprovalSettings - The approval settings.

func (ApprovalSettings) MarshalJSON 

func (a ApprovalSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApprovalSettings.

type ApprovalStage 

type ApprovalStage struct {
	// The time in days when approval request would be timed out.
	ApprovalStageTimeOutInDays *int32 `json:"approvalStageTimeOutInDays,omitempty"`

	// The escalation approver of the request.
	EscalationApprovers []*UserSet `json:"escalationApprovers,omitempty"`

	// The time in minutes when the approval request would be escalated if the primary approver does not approves.
	EscalationTimeInMinutes *int32 `json:"escalationTimeInMinutes,omitempty"`

	// Determine whether approver need to provide justification for his decision.
	IsApproverJustificationRequired *bool `json:"isApproverJustificationRequired,omitempty"`

	// The value determine whether escalation feature is enabled.
	IsEscalationEnabled *bool `json:"isEscalationEnabled,omitempty"`

	// The primary approver of the request.
	PrimaryApprovers []*UserSet `json:"primaryApprovers,omitempty"`
}

ApprovalStage - The approval stage.

func (ApprovalStage) MarshalJSON 

func (a ApprovalStage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApprovalStage.

type AssignmentType 

type AssignmentType string

AssignmentType - Assignment type of the role assignment schedule 

const (
	AssignmentTypeActivated AssignmentType = "Activated"
	AssignmentTypeAssigned  AssignmentType = "Assigned"
)

func PossibleAssignmentTypeValues 

func PossibleAssignmentTypeValues() []AssignmentType

PossibleAssignmentTypeValues returns the possible values for the AssignmentType const type.

func (AssignmentType) ToPtr 

func (c AssignmentType) ToPtr() *AssignmentType

ToPtr returns a *AssignmentType pointing to the current value.

type CloudError 

type CloudError struct {
	// An error response from the service.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError - An error response from the service.

type CloudErrorBody 

type CloudErrorBody struct {
	// An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`

	// A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
}

CloudErrorBody - An error response from the service.

type DecisionTargetType 

type DecisionTargetType string

DecisionTargetType - The type of decision target : User/ServicePrincipal 

const (
	DecisionTargetTypeServicePrincipal DecisionTargetType = "servicePrincipal"
	DecisionTargetTypeUser             DecisionTargetType = "user"
)

func PossibleDecisionTargetTypeValues 

func PossibleDecisionTargetTypeValues() []DecisionTargetType

PossibleDecisionTargetTypeValues returns the possible values for the DecisionTargetType const type.

func (DecisionTargetType) ToPtr 

func (c DecisionTargetType) ToPtr() *DecisionTargetType

ToPtr returns a *DecisionTargetType pointing to the current value.

type DefaultDecisionType 

type DefaultDecisionType string

DefaultDecisionType - This specifies the behavior for the autoReview feature when an access review completes. 

const (
	DefaultDecisionTypeApprove        DefaultDecisionType = "Approve"
	DefaultDecisionTypeDeny           DefaultDecisionType = "Deny"
	DefaultDecisionTypeRecommendation DefaultDecisionType = "Recommendation"
)

func PossibleDefaultDecisionTypeValues 

func PossibleDefaultDecisionTypeValues() []DefaultDecisionType

PossibleDefaultDecisionTypeValues returns the possible values for the DefaultDecisionType const type.

func (DefaultDecisionType) ToPtr 

func (c DefaultDecisionType) ToPtr() *DefaultDecisionType

ToPtr returns a *DefaultDecisionType pointing to the current value.

type DenyAssignment 

type DenyAssignment struct {
	// Deny assignment properties.
	Properties *DenyAssignmentProperties `json:"properties,omitempty"`

	// READ-ONLY; The deny assignment ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The deny assignment name.
	Name *string `json:"name,omitempty" azure:"ro"`

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

DenyAssignment - Deny Assignment

type DenyAssignmentFilter 

type DenyAssignmentFilter struct {
	// Return deny assignment with specified name.
	DenyAssignmentName *string `json:"denyAssignmentName,omitempty"`

	// Return all deny assignments where the specified principal is listed either in the principals list or exclude principals
	// list of deny assignments.
	GdprExportPrincipalID *string `json:"gdprExportPrincipalId,omitempty"`

	// Return all deny assignments where the specified principal is listed in the principals list of deny assignments.
	PrincipalID *string `json:"principalId,omitempty"`
}

DenyAssignmentFilter - Deny Assignments filter

type DenyAssignmentListResult 

type DenyAssignmentListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Deny assignment list.
	Value []*DenyAssignment `json:"value,omitempty"`
}

DenyAssignmentListResult - Deny assignment list operation result.

func (DenyAssignmentListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DenyAssignmentListResult.

type DenyAssignmentPermission 

type DenyAssignmentPermission struct {
	// Actions to which the deny assignment does not grant access.
	Actions []*string `json:"actions,omitempty"`

	// Data actions to which the deny assignment does not grant access.
	DataActions []*string `json:"dataActions,omitempty"`

	// Actions to exclude from that the deny assignment does not grant access.
	NotActions []*string `json:"notActions,omitempty"`

	// Data actions to exclude from that the deny assignment does not grant access.
	NotDataActions []*string `json:"notDataActions,omitempty"`
}

DenyAssignmentPermission - Deny assignment permissions.

func (DenyAssignmentPermission) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DenyAssignmentPermission.

type DenyAssignmentProperties 

type DenyAssignmentProperties struct {
	// The display name of the deny assignment.
	DenyAssignmentName *string `json:"denyAssignmentName,omitempty"`

	// The description of the deny assignment.
	Description *string `json:"description,omitempty"`

	// Determines if the deny assignment applies to child scopes. Default value is false.
	DoNotApplyToChildScopes *bool `json:"doNotApplyToChildScopes,omitempty"`

	// Array of principals to which the deny assignment does not apply.
	ExcludePrincipals []*Principal `json:"excludePrincipals,omitempty"`

	// Specifies whether this deny assignment was created by Azure and cannot be edited or deleted.
	IsSystemProtected *bool `json:"isSystemProtected,omitempty"`

	// An array of permissions that are denied by the deny assignment.
	Permissions []*DenyAssignmentPermission `json:"permissions,omitempty"`

	// Array of principals to which the deny assignment applies.
	Principals []*Principal `json:"principals,omitempty"`

	// The deny assignment scope.
	Scope *string `json:"scope,omitempty"`
}

DenyAssignmentProperties - Deny assignment properties.

func (DenyAssignmentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DenyAssignmentProperties.

type DenyAssignmentsClient 

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

DenyAssignmentsClient contains the methods for the DenyAssignments group. Don't use this type directly, use NewDenyAssignmentsClient() instead.

func NewDenyAssignmentsClient 

func NewDenyAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DenyAssignmentsClient

NewDenyAssignmentsClient creates a new instance of DenyAssignmentsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DenyAssignmentsClient) Get 

func (client *DenyAssignmentsClient) Get(ctx context.Context, scope string, denyAssignmentID string, options *DenyAssignmentsClientGetOptions) (DenyAssignmentsClientGetResponse, error)

Get - Get the specified deny assignment. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the deny assignment. denyAssignmentID - The ID of the deny assignment to get. options - DenyAssignmentsClientGetOptions contains the optional parameters for the DenyAssignmentsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-07-01-preview/examples/GetDenyAssignmentByNameId.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewDenyAssignmentsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<deny-assignment-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DenyAssignmentsClientGetResult)
}

Output:

func (*DenyAssignmentsClient) GetByID 

func (client *DenyAssignmentsClient) GetByID(ctx context.Context, denyAssignmentID string, options *DenyAssignmentsClientGetByIDOptions) (DenyAssignmentsClientGetByIDResponse, error)

GetByID - Gets a deny assignment by ID. If the operation fails it returns an *azcore.ResponseError type. denyAssignmentID - The fully qualified deny assignment ID. For example, use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} for subscription level deny assignments, or /providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} for tenant level deny assignments. options - DenyAssignmentsClientGetByIDOptions contains the optional parameters for the DenyAssignmentsClient.GetByID method.

func (*DenyAssignmentsClient) List 

func (client *DenyAssignmentsClient) List(options *DenyAssignmentsClientListOptions) *DenyAssignmentsClientListPager

List - Gets all deny assignments for the subscription. If the operation fails it returns an *azcore.ResponseError type. options - DenyAssignmentsClientListOptions contains the optional parameters for the DenyAssignmentsClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-07-01-preview/examples/GetAllDenyAssignments.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewDenyAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.List(&armauthorization.DenyAssignmentsClientListOptions{Filter: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*DenyAssignmentsClient) ListForResource 

func (client *DenyAssignmentsClient) ListForResource(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, options *DenyAssignmentsClientListForResourceOptions) *DenyAssignmentsClientListForResourcePager

ListForResource - Gets deny assignments for a resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. resourceProviderNamespace - The namespace of the resource provider. parentResourcePath - The parent resource identity. resourceType - The resource type of the resource. resourceName - The name of the resource to get deny assignments for. options - DenyAssignmentsClientListForResourceOptions contains the optional parameters for the DenyAssignmentsClient.ListForResource method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-07-01-preview/examples/GetDenyAssignmentsForResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewDenyAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForResource("<resource-group-name>",
		"<resource-provider-namespace>",
		"<parent-resource-path>",
		"<resource-type>",
		"<resource-name>",
		&armauthorization.DenyAssignmentsClientListForResourceOptions{Filter: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*DenyAssignmentsClient) ListForResourceGroup 

func (client *DenyAssignmentsClient) ListForResourceGroup(resourceGroupName string, options *DenyAssignmentsClientListForResourceGroupOptions) *DenyAssignmentsClientListForResourceGroupPager

ListForResourceGroup - Gets deny assignments for a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - DenyAssignmentsClientListForResourceGroupOptions contains the optional parameters for the DenyAssignmentsClient.ListForResourceGroup method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-07-01-preview/examples/GetDenyAssignmentsForResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewDenyAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForResourceGroup("<resource-group-name>",
		&armauthorization.DenyAssignmentsClientListForResourceGroupOptions{Filter: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*DenyAssignmentsClient) ListForScope 

func (client *DenyAssignmentsClient) ListForScope(scope string, options *DenyAssignmentsClientListForScopeOptions) *DenyAssignmentsClientListForScopePager

ListForScope - Gets deny assignments for a scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the deny assignments. options - DenyAssignmentsClientListForScopeOptions contains the optional parameters for the DenyAssignmentsClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-07-01-preview/examples/GetDenyAssignmentByScope.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewDenyAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.DenyAssignmentsClientListForScopeOptions{Filter: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type DenyAssignmentsClientGetByIDOptions added in v0.3.0 

type DenyAssignmentsClientGetByIDOptions struct {
}

DenyAssignmentsClientGetByIDOptions contains the optional parameters for the DenyAssignmentsClient.GetByID method.

type DenyAssignmentsClientGetByIDResponse added in v0.3.0 

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

DenyAssignmentsClientGetByIDResponse contains the response from method DenyAssignmentsClient.GetByID.

type DenyAssignmentsClientGetByIDResult added in v0.3.0 

type DenyAssignmentsClientGetByIDResult struct {
	DenyAssignment
}

DenyAssignmentsClientGetByIDResult contains the result from method DenyAssignmentsClient.GetByID.

type DenyAssignmentsClientGetOptions added in v0.3.0 

type DenyAssignmentsClientGetOptions struct {
}

DenyAssignmentsClientGetOptions contains the optional parameters for the DenyAssignmentsClient.Get method.

type DenyAssignmentsClientGetResponse added in v0.3.0 

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

DenyAssignmentsClientGetResponse contains the response from method DenyAssignmentsClient.Get.

type DenyAssignmentsClientGetResult added in v0.3.0 

type DenyAssignmentsClientGetResult struct {
	DenyAssignment
}

DenyAssignmentsClientGetResult contains the result from method DenyAssignmentsClient.Get.

type DenyAssignmentsClientListForResourceGroupOptions added in v0.3.0 

type DenyAssignmentsClientListForResourceGroupOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName
	// eq '{name}' to search deny assignments by name at
	// specified scope. Use $filter=principalId eq '{id}' to return all deny assignments at, above and below the scope for the
	// specified principal. Use $filter=gdprExportPrincipalId eq '{id}' to return all
	// deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId
	// filter as it returns not only those deny assignments that contain the
	// specified principal is the Principals list but also those deny assignments that contain the specified principal is the
	// ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used,
	// only the deny assignment name and description properties are returned.
	Filter *string
}

DenyAssignmentsClientListForResourceGroupOptions contains the optional parameters for the DenyAssignmentsClient.ListForResourceGroup method.

type DenyAssignmentsClientListForResourceGroupPager added in v0.3.0 

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

DenyAssignmentsClientListForResourceGroupPager provides operations for iterating over paged responses.

func (*DenyAssignmentsClientListForResourceGroupPager) Err added in v0.3.0 

func (p *DenyAssignmentsClientListForResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*DenyAssignmentsClientListForResourceGroupPager) NextPage added in v0.3.0 

func (p *DenyAssignmentsClientListForResourceGroupPager) 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 (*DenyAssignmentsClientListForResourceGroupPager) PageResponse added in v0.3.0 

func (p *DenyAssignmentsClientListForResourceGroupPager) PageResponse() DenyAssignmentsClientListForResourceGroupResponse

PageResponse returns the current DenyAssignmentsClientListForResourceGroupResponse page.

type DenyAssignmentsClientListForResourceGroupResponse added in v0.3.0 

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

DenyAssignmentsClientListForResourceGroupResponse contains the response from method DenyAssignmentsClient.ListForResourceGroup.

type DenyAssignmentsClientListForResourceGroupResult added in v0.3.0 

type DenyAssignmentsClientListForResourceGroupResult struct {
	DenyAssignmentListResult
}

DenyAssignmentsClientListForResourceGroupResult contains the result from method DenyAssignmentsClient.ListForResourceGroup.

type DenyAssignmentsClientListForResourceOptions added in v0.3.0 

type DenyAssignmentsClientListForResourceOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName
	// eq '{name}' to search deny assignments by name at
	// specified scope. Use $filter=principalId eq '{id}' to return all deny assignments at, above and below the scope for the
	// specified principal. Use $filter=gdprExportPrincipalId eq '{id}' to return all
	// deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId
	// filter as it returns not only those deny assignments that contain the
	// specified principal is the Principals list but also those deny assignments that contain the specified principal is the
	// ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used,
	// only the deny assignment name and description properties are returned.
	Filter *string
}

DenyAssignmentsClientListForResourceOptions contains the optional parameters for the DenyAssignmentsClient.ListForResource method.

type DenyAssignmentsClientListForResourcePager added in v0.3.0 

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

DenyAssignmentsClientListForResourcePager provides operations for iterating over paged responses.

func (*DenyAssignmentsClientListForResourcePager) Err added in v0.3.0 

func (p *DenyAssignmentsClientListForResourcePager) Err() error

Err returns the last error encountered while paging.

func (*DenyAssignmentsClientListForResourcePager) NextPage added in v0.3.0 

func (p *DenyAssignmentsClientListForResourcePager) 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 (*DenyAssignmentsClientListForResourcePager) PageResponse added in v0.3.0 

func (p *DenyAssignmentsClientListForResourcePager) PageResponse() DenyAssignmentsClientListForResourceResponse

PageResponse returns the current DenyAssignmentsClientListForResourceResponse page.

type DenyAssignmentsClientListForResourceResponse added in v0.3.0 

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

DenyAssignmentsClientListForResourceResponse contains the response from method DenyAssignmentsClient.ListForResource.

type DenyAssignmentsClientListForResourceResult added in v0.3.0 

type DenyAssignmentsClientListForResourceResult struct {
	DenyAssignmentListResult
}

DenyAssignmentsClientListForResourceResult contains the result from method DenyAssignmentsClient.ListForResource.

type DenyAssignmentsClientListForScopeOptions added in v0.3.0 

type DenyAssignmentsClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName
	// eq '{name}' to search deny assignments by name at
	// specified scope. Use $filter=principalId eq '{id}' to return all deny assignments at, above and below the scope for the
	// specified principal. Use $filter=gdprExportPrincipalId eq '{id}' to return all
	// deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId
	// filter as it returns not only those deny assignments that contain the
	// specified principal is the Principals list but also those deny assignments that contain the specified principal is the
	// ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used,
	// only the deny assignment name and description properties are returned.
	Filter *string
}

DenyAssignmentsClientListForScopeOptions contains the optional parameters for the DenyAssignmentsClient.ListForScope method.

type DenyAssignmentsClientListForScopePager added in v0.3.0 

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

DenyAssignmentsClientListForScopePager provides operations for iterating over paged responses.

func (*DenyAssignmentsClientListForScopePager) Err added in v0.3.0 

func (p *DenyAssignmentsClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*DenyAssignmentsClientListForScopePager) NextPage added in v0.3.0 

func (p *DenyAssignmentsClientListForScopePager) 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 (*DenyAssignmentsClientListForScopePager) PageResponse added in v0.3.0 

func (p *DenyAssignmentsClientListForScopePager) PageResponse() DenyAssignmentsClientListForScopeResponse

PageResponse returns the current DenyAssignmentsClientListForScopeResponse page.

type DenyAssignmentsClientListForScopeResponse added in v0.3.0 

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

DenyAssignmentsClientListForScopeResponse contains the response from method DenyAssignmentsClient.ListForScope.

type DenyAssignmentsClientListForScopeResult added in v0.3.0 

type DenyAssignmentsClientListForScopeResult struct {
	DenyAssignmentListResult
}

DenyAssignmentsClientListForScopeResult contains the result from method DenyAssignmentsClient.ListForScope.

type DenyAssignmentsClientListOptions added in v0.3.0 

type DenyAssignmentsClientListOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName
	// eq '{name}' to search deny assignments by name at
	// specified scope. Use $filter=principalId eq '{id}' to return all deny assignments at, above and below the scope for the
	// specified principal. Use $filter=gdprExportPrincipalId eq '{id}' to return all
	// deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId
	// filter as it returns not only those deny assignments that contain the
	// specified principal is the Principals list but also those deny assignments that contain the specified principal is the
	// ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used,
	// only the deny assignment name and description properties are returned.
	Filter *string
}

DenyAssignmentsClientListOptions contains the optional parameters for the DenyAssignmentsClient.List method.

type DenyAssignmentsClientListPager added in v0.3.0 

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

DenyAssignmentsClientListPager provides operations for iterating over paged responses.

func (*DenyAssignmentsClientListPager) Err added in v0.3.0 

func (p *DenyAssignmentsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*DenyAssignmentsClientListPager) NextPage added in v0.3.0 

func (p *DenyAssignmentsClientListPager) 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 (*DenyAssignmentsClientListPager) PageResponse added in v0.3.0 

func (p *DenyAssignmentsClientListPager) PageResponse() DenyAssignmentsClientListResponse

PageResponse returns the current DenyAssignmentsClientListResponse page.

type DenyAssignmentsClientListResponse added in v0.3.0 

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

DenyAssignmentsClientListResponse contains the response from method DenyAssignmentsClient.List.

type DenyAssignmentsClientListResult added in v0.3.0 

type DenyAssignmentsClientListResult struct {
	DenyAssignmentListResult
}

DenyAssignmentsClientListResult contains the result from method DenyAssignmentsClient.List.

type EligibleChildResource 

type EligibleChildResource struct {
	// READ-ONLY; The resource scope Id.
	ID *string `json:"id,omitempty" azure:"ro"`

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

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

EligibleChildResource - Eligible child resource

type EligibleChildResourcesClient 

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

EligibleChildResourcesClient contains the methods for the EligibleChildResources group. Don't use this type directly, use NewEligibleChildResourcesClient() instead.

func NewEligibleChildResourcesClient 

func NewEligibleChildResourcesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *EligibleChildResourcesClient

NewEligibleChildResourcesClient creates a new instance of EligibleChildResourcesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EligibleChildResourcesClient) Get 

func (client *EligibleChildResourcesClient) Get(scope string, options *EligibleChildResourcesClientGetOptions) *EligibleChildResourcesClientGetPager

Get - Get the child resources of a resource on which user has eligible access If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy. options - EligibleChildResourcesClientGetOptions contains the optional parameters for the EligibleChildResourcesClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetEligibleChildResourcesByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewEligibleChildResourcesClient(cred, nil)
	pager := client.Get("<scope>",
		&armauthorization.EligibleChildResourcesClientGetOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type EligibleChildResourcesClientGetOptions added in v0.3.0 

type EligibleChildResourcesClientGetOptions struct {
	// The filter to apply on the operation. Use $filter=resourceType+eq+'Subscription' to filter on only resource of type = 'Subscription'.
	// Use
	// $filter=resourceType+eq+'subscription'+or+resourceType+eq+'resourcegroup' to filter on resource of type = 'Subscription'
	// or 'ResourceGroup'
	Filter *string
}

EligibleChildResourcesClientGetOptions contains the optional parameters for the EligibleChildResourcesClient.Get method.

type EligibleChildResourcesClientGetPager added in v0.3.0 

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

EligibleChildResourcesClientGetPager provides operations for iterating over paged responses.

func (*EligibleChildResourcesClientGetPager) Err added in v0.3.0 

func (p *EligibleChildResourcesClientGetPager) Err() error

Err returns the last error encountered while paging.

func (*EligibleChildResourcesClientGetPager) NextPage added in v0.3.0 

func (p *EligibleChildResourcesClientGetPager) 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 (*EligibleChildResourcesClientGetPager) PageResponse added in v0.3.0 

func (p *EligibleChildResourcesClientGetPager) PageResponse() EligibleChildResourcesClientGetResponse

PageResponse returns the current EligibleChildResourcesClientGetResponse page.

type EligibleChildResourcesClientGetResponse added in v0.3.0 

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

EligibleChildResourcesClientGetResponse contains the response from method EligibleChildResourcesClient.Get.

type EligibleChildResourcesClientGetResult added in v0.3.0 

type EligibleChildResourcesClientGetResult struct {
	EligibleChildResourcesListResult
}

EligibleChildResourcesClientGetResult contains the result from method EligibleChildResourcesClient.Get.

type EligibleChildResourcesListResult 

type EligibleChildResourcesListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Eligible child resource list.
	Value []*EligibleChildResource `json:"value,omitempty"`
}

EligibleChildResourcesListResult - Eligible child resources list operation result.

func (EligibleChildResourcesListResult) MarshalJSON 

func (e EligibleChildResourcesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EligibleChildResourcesListResult.

type EnablementRules 

type EnablementRules string

EnablementRules - The type of enable rules 

const (
	EnablementRulesJustification             EnablementRules = "Justification"
	EnablementRulesMultiFactorAuthentication EnablementRules = "MultiFactorAuthentication"
	EnablementRulesTicketing                 EnablementRules = "Ticketing"
)

func PossibleEnablementRulesValues 

func PossibleEnablementRulesValues() []EnablementRules

PossibleEnablementRulesValues returns the possible values for the EnablementRules const type.

func (EnablementRules) ToPtr 

func (c EnablementRules) ToPtr() *EnablementRules

ToPtr returns a *EnablementRules pointing to the current value.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

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

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDefinition 

type ErrorDefinition struct {
	// Error of the list gateway status.
	Error *ErrorDefinitionProperties `json:"error,omitempty"`
}

ErrorDefinition - Error description and code explaining why an operation failed.

type ErrorDefinitionProperties 

type ErrorDefinitionProperties struct {
	// Error code of list gateway.
	Code *string `json:"code,omitempty"`

	// READ-ONLY; Description of the error.
	Message *string `json:"message,omitempty" azure:"ro"`
}

ErrorDefinitionProperties - Error description and code explaining why an operation failed.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type ExpandedProperties 

type ExpandedProperties struct {
	// Details of the principal
	Principal *ExpandedPropertiesPrincipal `json:"principal,omitempty"`

	// Details of role definition
	RoleDefinition *ExpandedPropertiesRoleDefinition `json:"roleDefinition,omitempty"`

	// Details of the resource scope
	Scope *ExpandedPropertiesScope `json:"scope,omitempty"`
}

type ExpandedPropertiesPrincipal 

type ExpandedPropertiesPrincipal struct {
	// Display name of the principal
	DisplayName *string `json:"displayName,omitempty"`

	// Email id of the principal
	Email *string `json:"email,omitempty"`

	// Id of the principal
	ID *string `json:"id,omitempty"`

	// Type of the principal
	Type *string `json:"type,omitempty"`
}

ExpandedPropertiesPrincipal - Details of the principal

type ExpandedPropertiesRoleDefinition 

type ExpandedPropertiesRoleDefinition struct {
	// Display name of the role definition
	DisplayName *string `json:"displayName,omitempty"`

	// Id of the role definition
	ID *string `json:"id,omitempty"`

	// Type of the role definition
	Type *string `json:"type,omitempty"`
}

ExpandedPropertiesRoleDefinition - Details of role definition

type ExpandedPropertiesScope 

type ExpandedPropertiesScope struct {
	// Display name of the resource
	DisplayName *string `json:"displayName,omitempty"`

	// Scope id of the resource
	ID *string `json:"id,omitempty"`

	// Type of the resource
	Type *string `json:"type,omitempty"`
}

ExpandedPropertiesScope - Details of the resource scope

type MemberType 

type MemberType string

MemberType - Membership type of the role assignment schedule 

const (
	MemberTypeDirect    MemberType = "Direct"
	MemberTypeGroup     MemberType = "Group"
	MemberTypeInherited MemberType = "Inherited"
)

func PossibleMemberTypeValues 

func PossibleMemberTypeValues() []MemberType

PossibleMemberTypeValues returns the possible values for the MemberType const type.

func (MemberType) ToPtr 

func (c MemberType) ToPtr() *MemberType

ToPtr returns a *MemberType pointing to the current value.

type NotificationDeliveryMechanism 

type NotificationDeliveryMechanism string

NotificationDeliveryMechanism - The type of notification. 

const (
	NotificationDeliveryMechanismEmail NotificationDeliveryMechanism = "Email"
)

func PossibleNotificationDeliveryMechanismValues 

func PossibleNotificationDeliveryMechanismValues() []NotificationDeliveryMechanism

PossibleNotificationDeliveryMechanismValues returns the possible values for the NotificationDeliveryMechanism const type.

func (NotificationDeliveryMechanism) ToPtr 

func (c NotificationDeliveryMechanism) ToPtr() *NotificationDeliveryMechanism

ToPtr returns a *NotificationDeliveryMechanism pointing to the current value.

type NotificationLevel 

type NotificationLevel string

NotificationLevel - The notification level. 

const (
	NotificationLevelAll      NotificationLevel = "All"
	NotificationLevelCritical NotificationLevel = "Critical"
	NotificationLevelNone     NotificationLevel = "None"
)

func PossibleNotificationLevelValues 

func PossibleNotificationLevelValues() []NotificationLevel

PossibleNotificationLevelValues returns the possible values for the NotificationLevel const type.

func (NotificationLevel) ToPtr 

func (c NotificationLevel) ToPtr() *NotificationLevel

ToPtr returns a *NotificationLevel pointing to the current value.

type Operation 

type Operation struct {
	// Display of the operation
	Display *OperationDisplay `json:"display,omitempty"`

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

	// Name of the operation
	Name *string `json:"name,omitempty"`

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

Operation - The definition of a Microsoft.Authorization operation.

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The description for the operation.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The operation that users can perform.
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; The resource provider name: Microsoft.Authorization.
	Provider *string `json:"provider,omitempty" azure:"ro"`

	// READ-ONLY; The resource on which the operation is performed.
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

OperationDisplay - The display information for a Microsoft.Authorization operation.

type OperationListResult 

type OperationListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - The result of a request to list Microsoft.Authorization operations.

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. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists the operations available from this provider. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListPager added in v0.3.0 

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

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.3.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.3.0 

func (p *OperationsClientListPager) 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 (*OperationsClientListPager) PageResponse added in v0.3.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.3.0 

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

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.3.0 

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List.

type Permission 

type Permission struct {
	// Allowed actions.
	Actions []*string `json:"actions,omitempty"`

	// Allowed Data actions.
	DataActions []*string `json:"dataActions,omitempty"`

	// Denied actions.
	NotActions []*string `json:"notActions,omitempty"`

	// Denied Data actions.
	NotDataActions []*string `json:"notDataActions,omitempty"`
}

Permission - Role definition permissions.

func (Permission) MarshalJSON 

func (p Permission) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Permission.

type PermissionGetResult 

type PermissionGetResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of permissions.
	Value []*Permission `json:"value,omitempty"`
}

PermissionGetResult - Permissions information.

func (PermissionGetResult) MarshalJSON 

func (p PermissionGetResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PermissionGetResult.

type PermissionsClient 

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

PermissionsClient contains the methods for the Permissions group. Don't use this type directly, use NewPermissionsClient() instead.

func NewPermissionsClient 

func NewPermissionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PermissionsClient

NewPermissionsClient creates a new instance of PermissionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PermissionsClient) ListForResource 

func (client *PermissionsClient) ListForResource(resourceGroupName string, resourceProviderNamespace string, parentResourcePath string, resourceType string, resourceName string, options *PermissionsClientListForResourceOptions) *PermissionsClientListForResourcePager

ListForResource - Gets all permissions the caller has for a resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. resourceProviderNamespace - The namespace of the resource provider. parentResourcePath - The parent resource identity. resourceType - The resource type of the resource. resourceName - The name of the resource to get the permissions for. options - PermissionsClientListForResourceOptions contains the optional parameters for the PermissionsClient.ListForResource method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/GetResourcePermissions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewPermissionsClient("<subscription-id>", cred, nil)
	pager := client.ListForResource("<resource-group-name>",
		"<resource-provider-namespace>",
		"<parent-resource-path>",
		"<resource-type>",
		"<resource-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PermissionsClient) ListForResourceGroup 

func (client *PermissionsClient) ListForResourceGroup(resourceGroupName string, options *PermissionsClientListForResourceGroupOptions) *PermissionsClientListForResourceGroupPager

ListForResourceGroup - Gets all permissions the caller has for a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - PermissionsClientListForResourceGroupOptions contains the optional parameters for the PermissionsClient.ListForResourceGroup method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/GetPermissions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewPermissionsClient("<subscription-id>", cred, nil)
	pager := client.ListForResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type PermissionsClientListForResourceGroupOptions added in v0.3.0 

type PermissionsClientListForResourceGroupOptions struct {
}

PermissionsClientListForResourceGroupOptions contains the optional parameters for the PermissionsClient.ListForResourceGroup method.

type PermissionsClientListForResourceGroupPager added in v0.3.0 

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

PermissionsClientListForResourceGroupPager provides operations for iterating over paged responses.

func (*PermissionsClientListForResourceGroupPager) Err added in v0.3.0 

func (p *PermissionsClientListForResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*PermissionsClientListForResourceGroupPager) NextPage added in v0.3.0 

func (p *PermissionsClientListForResourceGroupPager) 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 (*PermissionsClientListForResourceGroupPager) PageResponse added in v0.3.0 

func (p *PermissionsClientListForResourceGroupPager) PageResponse() PermissionsClientListForResourceGroupResponse

PageResponse returns the current PermissionsClientListForResourceGroupResponse page.

type PermissionsClientListForResourceGroupResponse added in v0.3.0 

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

PermissionsClientListForResourceGroupResponse contains the response from method PermissionsClient.ListForResourceGroup.

type PermissionsClientListForResourceGroupResult added in v0.3.0 

type PermissionsClientListForResourceGroupResult struct {
	PermissionGetResult
}

PermissionsClientListForResourceGroupResult contains the result from method PermissionsClient.ListForResourceGroup.

type PermissionsClientListForResourceOptions added in v0.3.0 

type PermissionsClientListForResourceOptions struct {
}

PermissionsClientListForResourceOptions contains the optional parameters for the PermissionsClient.ListForResource method.

type PermissionsClientListForResourcePager added in v0.3.0 

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

PermissionsClientListForResourcePager provides operations for iterating over paged responses.

func (*PermissionsClientListForResourcePager) Err added in v0.3.0 

func (p *PermissionsClientListForResourcePager) Err() error

Err returns the last error encountered while paging.

func (*PermissionsClientListForResourcePager) NextPage added in v0.3.0 

func (p *PermissionsClientListForResourcePager) 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 (*PermissionsClientListForResourcePager) PageResponse added in v0.3.0 

func (p *PermissionsClientListForResourcePager) PageResponse() PermissionsClientListForResourceResponse

PageResponse returns the current PermissionsClientListForResourceResponse page.

type PermissionsClientListForResourceResponse added in v0.3.0 

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

PermissionsClientListForResourceResponse contains the response from method PermissionsClient.ListForResource.

type PermissionsClientListForResourceResult added in v0.3.0 

type PermissionsClientListForResourceResult struct {
	PermissionGetResult
}

PermissionsClientListForResourceResult contains the result from method PermissionsClient.ListForResource.

type PolicyAssignmentProperties 

type PolicyAssignmentProperties struct {
	// Details of the policy
	Policy *PolicyAssignmentPropertiesPolicy `json:"policy,omitempty"`

	// Details of role definition
	RoleDefinition *PolicyAssignmentPropertiesRoleDefinition `json:"roleDefinition,omitempty"`

	// Details of the resource scope
	Scope *PolicyAssignmentPropertiesScope `json:"scope,omitempty"`
}

type PolicyAssignmentPropertiesPolicy 

type PolicyAssignmentPropertiesPolicy struct {
	// Id of the policy
	ID *string `json:"id,omitempty"`

	// The last modified date time.
	LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty"`

	// READ-ONLY; The name of the entity last modified it
	LastModifiedBy *Principal `json:"lastModifiedBy,omitempty" azure:"ro"`
}

PolicyAssignmentPropertiesPolicy - Details of the policy

func (PolicyAssignmentPropertiesPolicy) MarshalJSON 

func (p PolicyAssignmentPropertiesPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicyAssignmentPropertiesPolicy.

func (*PolicyAssignmentPropertiesPolicy) UnmarshalJSON 

func (p *PolicyAssignmentPropertiesPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PolicyAssignmentPropertiesPolicy.

type PolicyAssignmentPropertiesRoleDefinition 

type PolicyAssignmentPropertiesRoleDefinition struct {
	// Display name of the role definition
	DisplayName *string `json:"displayName,omitempty"`

	// Id of the role definition
	ID *string `json:"id,omitempty"`

	// Type of the role definition
	Type *string `json:"type,omitempty"`
}

PolicyAssignmentPropertiesRoleDefinition - Details of role definition

type PolicyAssignmentPropertiesScope 

type PolicyAssignmentPropertiesScope struct {
	// Display name of the resource
	DisplayName *string `json:"displayName,omitempty"`

	// Scope id of the resource
	ID *string `json:"id,omitempty"`

	// Type of the resource
	Type *string `json:"type,omitempty"`
}

PolicyAssignmentPropertiesScope - Details of the resource scope

type PolicyProperties 

type PolicyProperties struct {
	// READ-ONLY; Details of the resource scope
	Scope *PolicyPropertiesScope `json:"scope,omitempty" azure:"ro"`
}

type PolicyPropertiesScope 

type PolicyPropertiesScope struct {
	// Display name of the resource
	DisplayName *string `json:"displayName,omitempty"`

	// Scope id of the resource
	ID *string `json:"id,omitempty"`

	// Type of the resource
	Type *string `json:"type,omitempty"`
}

PolicyPropertiesScope - Details of the resource scope

type Principal 

type Principal struct {
	// The name of the principal made changes
	DisplayName *string `json:"displayName,omitempty"`

	// Email of principal
	Email *string `json:"email,omitempty"`

	// The id of the principal made changes
	ID *string `json:"id,omitempty"`

	// Type of principal such as user , group etc
	Type *string `json:"type,omitempty"`
}

Principal - The name of the entity last modified it

type PrincipalType 

type PrincipalType string

PrincipalType - The principal type of the assigned principal ID. 

const (
	PrincipalTypeDevice           PrincipalType = "Device"
	PrincipalTypeForeignGroup     PrincipalType = "ForeignGroup"
	PrincipalTypeGroup            PrincipalType = "Group"
	PrincipalTypeServicePrincipal PrincipalType = "ServicePrincipal"
	PrincipalTypeUser             PrincipalType = "User"
)

func PossiblePrincipalTypeValues 

func PossiblePrincipalTypeValues() []PrincipalType

PossiblePrincipalTypeValues returns the possible values for the PrincipalType const type.

func (PrincipalType) ToPtr 

func (c PrincipalType) ToPtr() *PrincipalType

ToPtr returns a *PrincipalType pointing to the current value.

type ProviderOperation 

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

	// The operation display name.
	DisplayName *string `json:"displayName,omitempty"`

	// The dataAction flag to specify the operation type.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// The operation name.
	Name *string `json:"name,omitempty"`

	// The operation origin.
	Origin *string `json:"origin,omitempty"`

	// The operation properties.
	Properties map[string]interface{} `json:"properties,omitempty"`
}

ProviderOperation - Operation

type ProviderOperationsMetadata 

type ProviderOperationsMetadata struct {
	// The provider display name.
	DisplayName *string `json:"displayName,omitempty"`

	// The provider id.
	ID *string `json:"id,omitempty"`

	// The provider name.
	Name *string `json:"name,omitempty"`

	// The provider operations.
	Operations []*ProviderOperation `json:"operations,omitempty"`

	// The provider resource types
	ResourceTypes []*ResourceType `json:"resourceTypes,omitempty"`

	// The provider type.
	Type *string `json:"type,omitempty"`
}

ProviderOperationsMetadata - Provider Operations metadata

func (ProviderOperationsMetadata) MarshalJSON 

func (p ProviderOperationsMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderOperationsMetadata.

type ProviderOperationsMetadataClient 

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

ProviderOperationsMetadataClient contains the methods for the ProviderOperationsMetadata group. Don't use this type directly, use NewProviderOperationsMetadataClient() instead.

func NewProviderOperationsMetadataClient 

func NewProviderOperationsMetadataClient(credential azcore.TokenCredential, options *arm.ClientOptions) *ProviderOperationsMetadataClient

NewProviderOperationsMetadataClient creates a new instance of ProviderOperationsMetadataClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ProviderOperationsMetadataClient) Get 

func (client *ProviderOperationsMetadataClient) Get(ctx context.Context, resourceProviderNamespace string, options *ProviderOperationsMetadataClientGetOptions) (ProviderOperationsMetadataClientGetResponse, error)

Get - Gets provider operations metadata for the specified resource provider. If the operation fails it returns an *azcore.ResponseError type. resourceProviderNamespace - The namespace of the resource provider. options - ProviderOperationsMetadataClientGetOptions contains the optional parameters for the ProviderOperationsMetadataClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/GetProviderOperationsRP.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewProviderOperationsMetadataClient(cred, nil)
	res, err := client.Get(ctx,
		"<resource-provider-namespace>",
		&armauthorization.ProviderOperationsMetadataClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProviderOperationsMetadataClientGetResult)
}

Output:

func (*ProviderOperationsMetadataClient) List 

func (client *ProviderOperationsMetadataClient) List(options *ProviderOperationsMetadataClientListOptions) *ProviderOperationsMetadataClientListPager

List - Gets provider operations metadata for all resource providers. If the operation fails it returns an *azcore.ResponseError type. options - ProviderOperationsMetadataClientListOptions contains the optional parameters for the ProviderOperationsMetadataClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/GetAllProviderOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewProviderOperationsMetadataClient(cred, nil)
	pager := client.List(&armauthorization.ProviderOperationsMetadataClientListOptions{Expand: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ProviderOperationsMetadataClientGetOptions added in v0.3.0 

type ProviderOperationsMetadataClientGetOptions struct {
	// Specifies whether to expand the values.
	Expand *string
}

ProviderOperationsMetadataClientGetOptions contains the optional parameters for the ProviderOperationsMetadataClient.Get method.

type ProviderOperationsMetadataClientGetResponse added in v0.3.0 

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

ProviderOperationsMetadataClientGetResponse contains the response from method ProviderOperationsMetadataClient.Get.

type ProviderOperationsMetadataClientGetResult added in v0.3.0 

type ProviderOperationsMetadataClientGetResult struct {
	ProviderOperationsMetadata
}

ProviderOperationsMetadataClientGetResult contains the result from method ProviderOperationsMetadataClient.Get.

type ProviderOperationsMetadataClientListOptions added in v0.3.0 

type ProviderOperationsMetadataClientListOptions struct {
	// Specifies whether to expand the values.
	Expand *string
}

ProviderOperationsMetadataClientListOptions contains the optional parameters for the ProviderOperationsMetadataClient.List method.

type ProviderOperationsMetadataClientListPager added in v0.3.0 

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

ProviderOperationsMetadataClientListPager provides operations for iterating over paged responses.

func (*ProviderOperationsMetadataClientListPager) Err added in v0.3.0 

func (p *ProviderOperationsMetadataClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ProviderOperationsMetadataClientListPager) NextPage added in v0.3.0 

func (p *ProviderOperationsMetadataClientListPager) 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 (*ProviderOperationsMetadataClientListPager) PageResponse added in v0.3.0 

func (p *ProviderOperationsMetadataClientListPager) PageResponse() ProviderOperationsMetadataClientListResponse

PageResponse returns the current ProviderOperationsMetadataClientListResponse page.

type ProviderOperationsMetadataClientListResponse added in v0.3.0 

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

ProviderOperationsMetadataClientListResponse contains the response from method ProviderOperationsMetadataClient.List.

type ProviderOperationsMetadataClientListResult added in v0.3.0 

type ProviderOperationsMetadataClientListResult struct {
	ProviderOperationsMetadataListResult
}

ProviderOperationsMetadataClientListResult contains the result from method ProviderOperationsMetadataClient.List.

type ProviderOperationsMetadataListResult 

type ProviderOperationsMetadataListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of providers.
	Value []*ProviderOperationsMetadata `json:"value,omitempty"`
}

ProviderOperationsMetadataListResult - Provider operations metadata list

func (ProviderOperationsMetadataListResult) MarshalJSON 

func (p ProviderOperationsMetadataListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProviderOperationsMetadataListResult.

type RecipientType 

type RecipientType string

RecipientType - The recipient type. 

const (
	RecipientTypeAdmin     RecipientType = "Admin"
	RecipientTypeApprover  RecipientType = "Approver"
	RecipientTypeRequestor RecipientType = "Requestor"
)

func PossibleRecipientTypeValues 

func PossibleRecipientTypeValues() []RecipientType

PossibleRecipientTypeValues returns the possible values for the RecipientType const type.

func (RecipientType) ToPtr 

func (c RecipientType) ToPtr() *RecipientType

ToPtr returns a *RecipientType pointing to the current value.

type RequestType 

type RequestType string

RequestType - The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc 

const (
	RequestTypeAdminAssign    RequestType = "AdminAssign"
	RequestTypeAdminExtend    RequestType = "AdminExtend"
	RequestTypeAdminRemove    RequestType = "AdminRemove"
	RequestTypeAdminRenew     RequestType = "AdminRenew"
	RequestTypeAdminUpdate    RequestType = "AdminUpdate"
	RequestTypeSelfActivate   RequestType = "SelfActivate"
	RequestTypeSelfDeactivate RequestType = "SelfDeactivate"
	RequestTypeSelfExtend     RequestType = "SelfExtend"
	RequestTypeSelfRenew      RequestType = "SelfRenew"
)

func PossibleRequestTypeValues 

func PossibleRequestTypeValues() []RequestType

PossibleRequestTypeValues returns the possible values for the RequestType const type.

func (RequestType) ToPtr 

func (c RequestType) ToPtr() *RequestType

ToPtr returns a *RequestType pointing to the current value.

type ResourceType 

type ResourceType struct {
	// The resource type display name.
	DisplayName *string `json:"displayName,omitempty"`

	// The resource type name.
	Name *string `json:"name,omitempty"`

	// The resource type operations.
	Operations []*ProviderOperation `json:"operations,omitempty"`
}

ResourceType - Resource Type

func (ResourceType) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceType.

type RoleAssignment 

type RoleAssignment struct {
	// Role assignment properties.
	Properties *RoleAssignmentProperties `json:"properties,omitempty"`

	// READ-ONLY; The role assignment ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment name.
	Name *string `json:"name,omitempty" azure:"ro"`

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

RoleAssignment - Role Assignments

type RoleAssignmentCreateParameters 

type RoleAssignmentCreateParameters struct {
	// REQUIRED; Role assignment properties.
	Properties *RoleAssignmentProperties `json:"properties,omitempty"`
}

RoleAssignmentCreateParameters - Role assignment create parameters.

type RoleAssignmentFilter 

type RoleAssignmentFilter struct {
	// Returns role assignment of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`
}

RoleAssignmentFilter - Role Assignments filter

type RoleAssignmentListResult 

type RoleAssignmentListResult struct {
	// Role assignment list.
	Value []*RoleAssignment `json:"value,omitempty"`

	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

RoleAssignmentListResult - Role assignment list operation result.

func (RoleAssignmentListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentListResult.

type RoleAssignmentMetricsClient 

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

RoleAssignmentMetricsClient contains the methods for the RoleAssignmentMetrics group. Don't use this type directly, use NewRoleAssignmentMetricsClient() instead.

func NewRoleAssignmentMetricsClient 

func NewRoleAssignmentMetricsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RoleAssignmentMetricsClient

NewRoleAssignmentMetricsClient creates a new instance of RoleAssignmentMetricsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleAssignmentMetricsClient) GetMetricsForSubscription 

func (client *RoleAssignmentMetricsClient) GetMetricsForSubscription(ctx context.Context, options *RoleAssignmentMetricsClientGetMetricsForSubscriptionOptions) (RoleAssignmentMetricsClientGetMetricsForSubscriptionResponse, error)

GetMetricsForSubscription - Get role assignment usage metrics for a subscription If the operation fails it returns an *azcore.ResponseError type. options - RoleAssignmentMetricsClientGetMetricsForSubscriptionOptions contains the optional parameters for the RoleAssignmentMetricsClient.GetMetricsForSubscription method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2019-08-01-preview/examples/RoleAssignmentMetrics_GetForSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentMetricsClient("<subscription-id>", cred, nil)
	res, err := client.GetMetricsForSubscription(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentMetricsClientGetMetricsForSubscriptionResult)
}

Output:

type RoleAssignmentMetricsClientGetMetricsForSubscriptionOptions added in v0.3.0 

type RoleAssignmentMetricsClientGetMetricsForSubscriptionOptions struct {
}

RoleAssignmentMetricsClientGetMetricsForSubscriptionOptions contains the optional parameters for the RoleAssignmentMetricsClient.GetMetricsForSubscription method.

type RoleAssignmentMetricsClientGetMetricsForSubscriptionResponse added in v0.3.0 

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

RoleAssignmentMetricsClientGetMetricsForSubscriptionResponse contains the response from method RoleAssignmentMetricsClient.GetMetricsForSubscription.

type RoleAssignmentMetricsClientGetMetricsForSubscriptionResult added in v0.3.0 

type RoleAssignmentMetricsClientGetMetricsForSubscriptionResult struct {
	RoleAssignmentMetricsResult
}

RoleAssignmentMetricsClientGetMetricsForSubscriptionResult contains the result from method RoleAssignmentMetricsClient.GetMetricsForSubscription.

type RoleAssignmentMetricsResult 

type RoleAssignmentMetricsResult struct {
	// READ-ONLY; The number of current role assignments.
	RoleAssignmentsCurrentCount *int64 `json:"roleAssignmentsCurrentCount,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment limit.
	RoleAssignmentsLimit *int64 `json:"roleAssignmentsLimit,omitempty" azure:"ro"`

	// READ-ONLY; The number of remaining role assignments available.
	RoleAssignmentsRemainingCount *int64 `json:"roleAssignmentsRemainingCount,omitempty" azure:"ro"`

	// READ-ONLY; The subscription ID.
	SubscriptionID *string `json:"subscriptionId,omitempty" azure:"ro"`
}

RoleAssignmentMetricsResult - Role Assignment Metrics

type RoleAssignmentProperties 

type RoleAssignmentProperties struct {
	// REQUIRED; The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// REQUIRED; The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// Id of the delegated managed identity resource
	DelegatedManagedIdentityResourceID *string `json:"delegatedManagedIdentityResourceId,omitempty"`

	// Description of role assignment
	Description *string `json:"description,omitempty"`

	// The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty"`

	// READ-ONLY; Id of the user who created the assignment
	CreatedBy *string `json:"createdBy,omitempty" azure:"ro"`

	// READ-ONLY; Time it was created
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment scope.
	Scope *string `json:"scope,omitempty" azure:"ro"`

	// READ-ONLY; Id of the user who updated the assignment
	UpdatedBy *string `json:"updatedBy,omitempty" azure:"ro"`

	// READ-ONLY; Time it was updated
	UpdatedOn *time.Time `json:"updatedOn,omitempty" azure:"ro"`
}

RoleAssignmentProperties - Role assignment properties.

func (RoleAssignmentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentProperties.

func (*RoleAssignmentProperties) UnmarshalJSON 

func (r *RoleAssignmentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentProperties.

type RoleAssignmentSchedule 

type RoleAssignmentSchedule struct {
	// Role assignment schedule properties.
	Properties *RoleAssignmentScheduleProperties `json:"properties,omitempty"`

	// READ-ONLY; The role assignment schedule Id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleAssignmentSchedule - Role Assignment schedule

type RoleAssignmentScheduleFilter 

type RoleAssignmentScheduleFilter struct {
	// Returns role assignment schedule of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`

	// Returns role assignment schedule of the specific role definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Returns role assignment schedule instances of the specific status.
	Status *string `json:"status,omitempty"`
}

RoleAssignmentScheduleFilter - Role assignment schedule filter

type RoleAssignmentScheduleInstance 

type RoleAssignmentScheduleInstance struct {
	// Role assignment schedule instance properties.
	Properties *RoleAssignmentScheduleInstanceProperties `json:"properties,omitempty"`

	// READ-ONLY; The role assignment schedule instance ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule instance name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule instance type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleAssignmentScheduleInstance - Information about current or upcoming role assignment schedule instance

type RoleAssignmentScheduleInstanceFilter 

type RoleAssignmentScheduleInstanceFilter struct {
	// Returns role assignment schedule instances of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`

	// Returns role assignment schedule instances belonging to a specific role assignment schedule.
	RoleAssignmentScheduleID *string `json:"roleAssignmentScheduleId,omitempty"`

	// Returns role assignment schedule instances of the specific role definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Returns role assignment schedule instances of the specific status.
	Status *string `json:"status,omitempty"`
}

RoleAssignmentScheduleInstanceFilter - Role assignment schedule instance filter

type RoleAssignmentScheduleInstanceListResult 

type RoleAssignmentScheduleInstanceListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role assignment schedule instance list.
	Value []*RoleAssignmentScheduleInstance `json:"value,omitempty"`
}

RoleAssignmentScheduleInstanceListResult - Role assignment schedule instance list operation result.

func (RoleAssignmentScheduleInstanceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleInstanceListResult.

type RoleAssignmentScheduleInstanceProperties 

type RoleAssignmentScheduleInstanceProperties struct {
	// Assignment type of the role assignment schedule
	AssignmentType *AssignmentType `json:"assignmentType,omitempty"`

	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// DateTime when role assignment schedule was created
	CreatedOn *time.Time `json:"createdOn,omitempty"`

	// The endDateTime of the role assignment schedule instance
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// Additional properties of principal, scope and role definition
	ExpandedProperties *ExpandedProperties `json:"expandedProperties,omitempty"`

	// roleEligibilityScheduleId used to activate
	LinkedRoleEligibilityScheduleID *string `json:"linkedRoleEligibilityScheduleId,omitempty"`

	// roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance
	LinkedRoleEligibilityScheduleInstanceID *string `json:"linkedRoleEligibilityScheduleInstanceId,omitempty"`

	// Membership type of the role assignment schedule
	MemberType *MemberType `json:"memberType,omitempty"`

	// Role Assignment Id in external system
	OriginRoleAssignmentID *string `json:"originRoleAssignmentId,omitempty"`

	// The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty"`

	// Id of the master role assignment schedule
	RoleAssignmentScheduleID *string `json:"roleAssignmentScheduleId,omitempty"`

	// The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The role assignment schedule scope.
	Scope *string `json:"scope,omitempty"`

	// The startDateTime of the role assignment schedule instance
	StartDateTime *time.Time `json:"startDateTime,omitempty"`

	// The status of the role assignment schedule instance.
	Status *Status `json:"status,omitempty"`
}

RoleAssignmentScheduleInstanceProperties - Role assignment schedule properties with scope.

func (RoleAssignmentScheduleInstanceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleInstanceProperties.

func (*RoleAssignmentScheduleInstanceProperties) UnmarshalJSON 

func (r *RoleAssignmentScheduleInstanceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentScheduleInstanceProperties.

type RoleAssignmentScheduleInstancesClient 

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

RoleAssignmentScheduleInstancesClient contains the methods for the RoleAssignmentScheduleInstances group. Don't use this type directly, use NewRoleAssignmentScheduleInstancesClient() instead.

func NewRoleAssignmentScheduleInstancesClient 

func NewRoleAssignmentScheduleInstancesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleAssignmentScheduleInstancesClient

NewRoleAssignmentScheduleInstancesClient creates a new instance of RoleAssignmentScheduleInstancesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleAssignmentScheduleInstancesClient) Get 

func (client *RoleAssignmentScheduleInstancesClient) Get(ctx context.Context, scope string, roleAssignmentScheduleInstanceName string, options *RoleAssignmentScheduleInstancesClientGetOptions) (RoleAssignmentScheduleInstancesClientGetResponse, error)

Get - Gets the specified role assignment schedule instance. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignments schedules. roleAssignmentScheduleInstanceName - The name (hash of schedule name + time) of the role assignment schedule to get. options - RoleAssignmentScheduleInstancesClientGetOptions contains the optional parameters for the RoleAssignmentScheduleInstancesClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentScheduleInstancesClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-assignment-schedule-instance-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentScheduleInstancesClientGetResult)
}

Output:

func (*RoleAssignmentScheduleInstancesClient) ListForScope 

func (client *RoleAssignmentScheduleInstancesClient) ListForScope(scope string, options *RoleAssignmentScheduleInstancesClientListForScopeOptions) *RoleAssignmentScheduleInstancesClientListForScopePager

ListForScope - Gets role assignment schedule instances of a role assignment schedule. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignment schedule. options - RoleAssignmentScheduleInstancesClientListForScopeOptions contains the optional parameters for the RoleAssignmentScheduleInstancesClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentScheduleInstancesClient(cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleAssignmentScheduleInstancesClientListForScopeOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleAssignmentScheduleInstancesClientGetOptions added in v0.3.0 

type RoleAssignmentScheduleInstancesClientGetOptions struct {
}

RoleAssignmentScheduleInstancesClientGetOptions contains the optional parameters for the RoleAssignmentScheduleInstancesClient.Get method.

type RoleAssignmentScheduleInstancesClientGetResponse added in v0.3.0 

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

RoleAssignmentScheduleInstancesClientGetResponse contains the response from method RoleAssignmentScheduleInstancesClient.Get.

type RoleAssignmentScheduleInstancesClientGetResult added in v0.3.0 

type RoleAssignmentScheduleInstancesClientGetResult struct {
	RoleAssignmentScheduleInstance
}

RoleAssignmentScheduleInstancesClientGetResult contains the result from method RoleAssignmentScheduleInstancesClient.Get.

type RoleAssignmentScheduleInstancesClientListForScopeOptions added in v0.3.0 

type RoleAssignmentScheduleInstancesClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope.
	// Use $filter=principalId eq {id} to return all role assignment schedules at,
	// above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment
	// schedule instances for the user. Use $filter=asTarget() to return all role
	// assignment schedule instances created for the current user.
	Filter *string
}

RoleAssignmentScheduleInstancesClientListForScopeOptions contains the optional parameters for the RoleAssignmentScheduleInstancesClient.ListForScope method.

type RoleAssignmentScheduleInstancesClientListForScopePager added in v0.3.0 

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

RoleAssignmentScheduleInstancesClientListForScopePager provides operations for iterating over paged responses.

func (*RoleAssignmentScheduleInstancesClientListForScopePager) Err added in v0.3.0 

func (p *RoleAssignmentScheduleInstancesClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentScheduleInstancesClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleAssignmentScheduleInstancesClientListForScopePager) 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 (*RoleAssignmentScheduleInstancesClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleAssignmentScheduleInstancesClientListForScopePager) PageResponse() RoleAssignmentScheduleInstancesClientListForScopeResponse

PageResponse returns the current RoleAssignmentScheduleInstancesClientListForScopeResponse page.

type RoleAssignmentScheduleInstancesClientListForScopeResponse added in v0.3.0 

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

RoleAssignmentScheduleInstancesClientListForScopeResponse contains the response from method RoleAssignmentScheduleInstancesClient.ListForScope.

type RoleAssignmentScheduleInstancesClientListForScopeResult added in v0.3.0 

type RoleAssignmentScheduleInstancesClientListForScopeResult struct {
	RoleAssignmentScheduleInstanceListResult
}

RoleAssignmentScheduleInstancesClientListForScopeResult contains the result from method RoleAssignmentScheduleInstancesClient.ListForScope.

type RoleAssignmentScheduleListResult 

type RoleAssignmentScheduleListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role assignment schedule list.
	Value []*RoleAssignmentSchedule `json:"value,omitempty"`
}

RoleAssignmentScheduleListResult - Role assignment schedule list operation result.

func (RoleAssignmentScheduleListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleListResult.

type RoleAssignmentScheduleProperties 

type RoleAssignmentScheduleProperties struct {
	// Assignment type of the role assignment schedule
	AssignmentType *AssignmentType `json:"assignmentType,omitempty"`

	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// DateTime when role assignment schedule was created
	CreatedOn *time.Time `json:"createdOn,omitempty"`

	// End DateTime when role assignment schedule
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// Additional properties of principal, scope and role definition
	ExpandedProperties *ExpandedProperties `json:"expandedProperties,omitempty"`

	// The id of roleEligibilitySchedule used to activated this roleAssignmentSchedule
	LinkedRoleEligibilityScheduleID *string `json:"linkedRoleEligibilityScheduleId,omitempty"`

	// Membership type of the role assignment schedule
	MemberType *MemberType `json:"memberType,omitempty"`

	// The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty"`

	// The id of roleAssignmentScheduleRequest used to create this roleAssignmentSchedule
	RoleAssignmentScheduleRequestID *string `json:"roleAssignmentScheduleRequestId,omitempty"`

	// The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The role assignment schedule scope.
	Scope *string `json:"scope,omitempty"`

	// Start DateTime when role assignment schedule
	StartDateTime *time.Time `json:"startDateTime,omitempty"`

	// The status of the role assignment schedule.
	Status *Status `json:"status,omitempty"`

	// DateTime when role assignment schedule was modified
	UpdatedOn *time.Time `json:"updatedOn,omitempty"`
}

RoleAssignmentScheduleProperties - Role assignment schedule properties with scope.

func (RoleAssignmentScheduleProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleProperties.

func (*RoleAssignmentScheduleProperties) UnmarshalJSON 

func (r *RoleAssignmentScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentScheduleProperties.

type RoleAssignmentScheduleRequest 

type RoleAssignmentScheduleRequest struct {
	// Role assignment schedule request properties.
	Properties *RoleAssignmentScheduleRequestProperties `json:"properties,omitempty"`

	// READ-ONLY; The role assignment schedule request ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule request name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule request type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleAssignmentScheduleRequest - Role Assignment schedule request

type RoleAssignmentScheduleRequestFilter 

type RoleAssignmentScheduleRequestFilter struct {
	// Returns role assignment requests of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`

	// Returns role assignment requests created by specific principal.
	RequestorID *string `json:"requestorId,omitempty"`

	// Returns role assignment requests of the specific role definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Returns role assignment requests of specific status.
	Status *string `json:"status,omitempty"`
}

RoleAssignmentScheduleRequestFilter - Role assignment schedule request filter

type RoleAssignmentScheduleRequestListResult 

type RoleAssignmentScheduleRequestListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role assignment schedule request list.
	Value []*RoleAssignmentScheduleRequest `json:"value,omitempty"`
}

RoleAssignmentScheduleRequestListResult - Role assignment schedule request list operation result.

func (RoleAssignmentScheduleRequestListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleRequestListResult.

type RoleAssignmentScheduleRequestProperties 

type RoleAssignmentScheduleRequestProperties struct {
	// REQUIRED; The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// REQUIRED; The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc
	RequestType *RequestType `json:"requestType,omitempty"`

	// REQUIRED; The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// Justification for the role assignment
	Justification *string `json:"justification,omitempty"`

	// The linked role eligibility schedule id - to activate an eligibility.
	LinkedRoleEligibilityScheduleID *string `json:"linkedRoleEligibilityScheduleId,omitempty"`

	// Schedule info of the role assignment schedule
	ScheduleInfo *RoleAssignmentScheduleRequestPropertiesScheduleInfo `json:"scheduleInfo,omitempty"`

	// The resultant role assignment schedule id or the role assignment schedule id being updated
	TargetRoleAssignmentScheduleID *string `json:"targetRoleAssignmentScheduleId,omitempty"`

	// The role assignment schedule instance id being updated
	TargetRoleAssignmentScheduleInstanceID *string `json:"targetRoleAssignmentScheduleInstanceId,omitempty"`

	// Ticket Info of the role assignment
	TicketInfo *RoleAssignmentScheduleRequestPropertiesTicketInfo `json:"ticketInfo,omitempty"`

	// READ-ONLY; The approvalId of the role assignment schedule request.
	ApprovalID *string `json:"approvalId,omitempty" azure:"ro"`

	// READ-ONLY; DateTime when role assignment schedule request was created
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Additional properties of principal, scope and role definition
	ExpandedProperties *ExpandedProperties `json:"expandedProperties,omitempty" azure:"ro"`

	// READ-ONLY; The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty" azure:"ro"`

	// READ-ONLY; Id of the user who created this request
	RequestorID *string `json:"requestorId,omitempty" azure:"ro"`

	// READ-ONLY; The role assignment schedule request scope.
	Scope *string `json:"scope,omitempty" azure:"ro"`

	// READ-ONLY; The status of the role assignment schedule request.
	Status *Status `json:"status,omitempty" azure:"ro"`
}

RoleAssignmentScheduleRequestProperties - Role assignment schedule request properties with scope.

func (RoleAssignmentScheduleRequestProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleRequestProperties.

func (*RoleAssignmentScheduleRequestProperties) UnmarshalJSON 

func (r *RoleAssignmentScheduleRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentScheduleRequestProperties.

type RoleAssignmentScheduleRequestPropertiesScheduleInfo 

type RoleAssignmentScheduleRequestPropertiesScheduleInfo struct {
	// Expiration of the role assignment schedule
	Expiration *RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration `json:"expiration,omitempty"`

	// Start DateTime of the role assignment schedule.
	StartDateTime *time.Time `json:"startDateTime,omitempty"`
}

RoleAssignmentScheduleRequestPropertiesScheduleInfo - Schedule info of the role assignment schedule

func (RoleAssignmentScheduleRequestPropertiesScheduleInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleRequestPropertiesScheduleInfo.

func (*RoleAssignmentScheduleRequestPropertiesScheduleInfo) UnmarshalJSON 

func (r *RoleAssignmentScheduleRequestPropertiesScheduleInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentScheduleRequestPropertiesScheduleInfo.

type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration 

type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration struct {
	// Duration of the role assignment schedule in TimeSpan.
	Duration *string `json:"duration,omitempty"`

	// End DateTime of the role assignment schedule.
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// Type of the role assignment schedule expiration
	Type *Type `json:"type,omitempty"`
}

RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration - Expiration of the role assignment schedule

func (RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration.

func (*RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) UnmarshalJSON 

func (r *RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration.

type RoleAssignmentScheduleRequestPropertiesTicketInfo 

type RoleAssignmentScheduleRequestPropertiesTicketInfo struct {
	// Ticket number for the role assignment
	TicketNumber *string `json:"ticketNumber,omitempty"`

	// Ticket system name for the role assignment
	TicketSystem *string `json:"ticketSystem,omitempty"`
}

RoleAssignmentScheduleRequestPropertiesTicketInfo - Ticket Info of the role assignment

type RoleAssignmentScheduleRequestsClient 

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

RoleAssignmentScheduleRequestsClient contains the methods for the RoleAssignmentScheduleRequests group. Don't use this type directly, use NewRoleAssignmentScheduleRequestsClient() instead.

func NewRoleAssignmentScheduleRequestsClient 

func NewRoleAssignmentScheduleRequestsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleAssignmentScheduleRequestsClient

NewRoleAssignmentScheduleRequestsClient creates a new instance of RoleAssignmentScheduleRequestsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleAssignmentScheduleRequestsClient) Cancel 

func (client *RoleAssignmentScheduleRequestsClient) Cancel(ctx context.Context, scope string, roleAssignmentScheduleRequestName string, options *RoleAssignmentScheduleRequestsClientCancelOptions) (RoleAssignmentScheduleRequestsClientCancelResponse, error)

Cancel - Cancels a pending role assignment schedule request. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignment request to cancel. roleAssignmentScheduleRequestName - The name of the role assignment request to cancel. options - RoleAssignmentScheduleRequestsClientCancelOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.Cancel method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentScheduleRequestsClient(cred, nil)
	_, err = client.Cancel(ctx,
		"<scope>",
		"<role-assignment-schedule-request-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleAssignmentScheduleRequestsClient) Create 

func (client *RoleAssignmentScheduleRequestsClient) Create(ctx context.Context, scope string, roleAssignmentScheduleRequestName string, parameters RoleAssignmentScheduleRequest, options *RoleAssignmentScheduleRequestsClientCreateOptions) (RoleAssignmentScheduleRequestsClientCreateResponse, error)

Create - Creates a role assignment schedule request. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignment schedule request to create. The scope can be any REST resource instance. For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource. roleAssignmentScheduleRequestName - A GUID for the role assignment to create. The name must be unique and different for each role assignment. parameters - Parameters for the role assignment schedule request. options - RoleAssignmentScheduleRequestsClientCreateOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.Create method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/PutRoleAssignmentScheduleRequest.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentScheduleRequestsClient(cred, nil)
	_, err = client.Create(ctx,
		"<scope>",
		"<role-assignment-schedule-request-name>",
		armauthorization.RoleAssignmentScheduleRequest{
			Properties: &armauthorization.RoleAssignmentScheduleRequestProperties{
				Condition:                       to.StringPtr("<condition>"),
				ConditionVersion:                to.StringPtr("<condition-version>"),
				LinkedRoleEligibilityScheduleID: to.StringPtr("<linked-role-eligibility-schedule-id>"),
				PrincipalID:                     to.StringPtr("<principal-id>"),
				RequestType:                     armauthorization.RequestType("SelfActivate").ToPtr(),
				RoleDefinitionID:                to.StringPtr("<role-definition-id>"),
				ScheduleInfo: &armauthorization.RoleAssignmentScheduleRequestPropertiesScheduleInfo{
					Expiration: &armauthorization.RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration{
						Type:     armauthorization.Type("AfterDuration").ToPtr(),
						Duration: to.StringPtr("<duration>"),
					},
					StartDateTime: to.TimePtr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.91Z"); return t }()),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleAssignmentScheduleRequestsClient) Get 

func (client *RoleAssignmentScheduleRequestsClient) Get(ctx context.Context, scope string, roleAssignmentScheduleRequestName string, options *RoleAssignmentScheduleRequestsClientGetOptions) (RoleAssignmentScheduleRequestsClientGetResponse, error)

Get - Get the specified role assignment schedule request. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignment schedule request. roleAssignmentScheduleRequestName - The name (guid) of the role assignment schedule request to get. options - RoleAssignmentScheduleRequestsClientGetOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentScheduleRequestsClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-assignment-schedule-request-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentScheduleRequestsClientGetResult)
}

Output:

func (*RoleAssignmentScheduleRequestsClient) ListForScope 

func (client *RoleAssignmentScheduleRequestsClient) ListForScope(scope string, options *RoleAssignmentScheduleRequestsClientListForScopeOptions) *RoleAssignmentScheduleRequestsClientListForScopePager

ListForScope - Gets role assignment schedule requests for a scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignments schedule requests. options - RoleAssignmentScheduleRequestsClientListForScopeOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentScheduleRequestsClient(cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleAssignmentScheduleRequestsClientListForScopeOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleAssignmentScheduleRequestsClientCancelOptions added in v0.3.0 

type RoleAssignmentScheduleRequestsClientCancelOptions struct {
}

RoleAssignmentScheduleRequestsClientCancelOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.Cancel method.

type RoleAssignmentScheduleRequestsClientCancelResponse added in v0.3.0 

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

RoleAssignmentScheduleRequestsClientCancelResponse contains the response from method RoleAssignmentScheduleRequestsClient.Cancel.

type RoleAssignmentScheduleRequestsClientCreateOptions added in v0.3.0 

type RoleAssignmentScheduleRequestsClientCreateOptions struct {
}

RoleAssignmentScheduleRequestsClientCreateOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.Create method.

type RoleAssignmentScheduleRequestsClientCreateResponse added in v0.3.0 

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

RoleAssignmentScheduleRequestsClientCreateResponse contains the response from method RoleAssignmentScheduleRequestsClient.Create.

type RoleAssignmentScheduleRequestsClientCreateResult added in v0.3.0 

type RoleAssignmentScheduleRequestsClientCreateResult struct {
	RoleAssignmentScheduleRequest
}

RoleAssignmentScheduleRequestsClientCreateResult contains the result from method RoleAssignmentScheduleRequestsClient.Create.

type RoleAssignmentScheduleRequestsClientGetOptions added in v0.3.0 

type RoleAssignmentScheduleRequestsClientGetOptions struct {
}

RoleAssignmentScheduleRequestsClientGetOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.Get method.

type RoleAssignmentScheduleRequestsClientGetResponse added in v0.3.0 

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

RoleAssignmentScheduleRequestsClientGetResponse contains the response from method RoleAssignmentScheduleRequestsClient.Get.

type RoleAssignmentScheduleRequestsClientGetResult added in v0.3.0 

type RoleAssignmentScheduleRequestsClientGetResult struct {
	RoleAssignmentScheduleRequest
}

RoleAssignmentScheduleRequestsClientGetResult contains the result from method RoleAssignmentScheduleRequestsClient.Get.

type RoleAssignmentScheduleRequestsClientListForScopeOptions added in v0.3.0 

type RoleAssignmentScheduleRequestsClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedule requests at or above
	// the scope. Use $filter=principalId eq {id} to return all role assignment
	// schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role
	// assignment schedule requests requested by the current user. Use
	// $filter=asTarget() to return all role assignment schedule requests created for the current user. Use $filter=asApprover()
	// to return all role assignment schedule requests where the current user is an
	// approver.
	Filter *string
}

RoleAssignmentScheduleRequestsClientListForScopeOptions contains the optional parameters for the RoleAssignmentScheduleRequestsClient.ListForScope method.

type RoleAssignmentScheduleRequestsClientListForScopePager added in v0.3.0 

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

RoleAssignmentScheduleRequestsClientListForScopePager provides operations for iterating over paged responses.

func (*RoleAssignmentScheduleRequestsClientListForScopePager) Err added in v0.3.0 

func (p *RoleAssignmentScheduleRequestsClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentScheduleRequestsClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleAssignmentScheduleRequestsClientListForScopePager) 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 (*RoleAssignmentScheduleRequestsClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleAssignmentScheduleRequestsClientListForScopePager) PageResponse() RoleAssignmentScheduleRequestsClientListForScopeResponse

PageResponse returns the current RoleAssignmentScheduleRequestsClientListForScopeResponse page.

type RoleAssignmentScheduleRequestsClientListForScopeResponse added in v0.3.0 

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

RoleAssignmentScheduleRequestsClientListForScopeResponse contains the response from method RoleAssignmentScheduleRequestsClient.ListForScope.

type RoleAssignmentScheduleRequestsClientListForScopeResult added in v0.3.0 

type RoleAssignmentScheduleRequestsClientListForScopeResult struct {
	RoleAssignmentScheduleRequestListResult
}

RoleAssignmentScheduleRequestsClientListForScopeResult contains the result from method RoleAssignmentScheduleRequestsClient.ListForScope.

type RoleAssignmentSchedulesClient 

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

RoleAssignmentSchedulesClient contains the methods for the RoleAssignmentSchedules group. Don't use this type directly, use NewRoleAssignmentSchedulesClient() instead.

func NewRoleAssignmentSchedulesClient 

func NewRoleAssignmentSchedulesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleAssignmentSchedulesClient

NewRoleAssignmentSchedulesClient creates a new instance of RoleAssignmentSchedulesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleAssignmentSchedulesClient) Get 

func (client *RoleAssignmentSchedulesClient) Get(ctx context.Context, scope string, roleAssignmentScheduleName string, options *RoleAssignmentSchedulesClientGetOptions) (RoleAssignmentSchedulesClientGetResponse, error)

Get - Get the specified role assignment schedule for a resource scope If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignment schedule. roleAssignmentScheduleName - The name (guid) of the role assignment schedule to get. options - RoleAssignmentSchedulesClientGetOptions contains the optional parameters for the RoleAssignmentSchedulesClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleAssignmentScheduleByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentSchedulesClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-assignment-schedule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentSchedulesClientGetResult)
}

Output:

func (*RoleAssignmentSchedulesClient) ListForScope 

func (client *RoleAssignmentSchedulesClient) ListForScope(scope string, options *RoleAssignmentSchedulesClientListForScopeOptions) *RoleAssignmentSchedulesClientListForScopePager

ListForScope - Gets role assignment schedules for a resource scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role assignments schedules. options - RoleAssignmentSchedulesClientListForScopeOptions contains the optional parameters for the RoleAssignmentSchedulesClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleAssignmentSchedulesByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentSchedulesClient(cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleAssignmentSchedulesClientListForScopeOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleAssignmentSchedulesClientGetOptions added in v0.3.0 

type RoleAssignmentSchedulesClientGetOptions struct {
}

RoleAssignmentSchedulesClientGetOptions contains the optional parameters for the RoleAssignmentSchedulesClient.Get method.

type RoleAssignmentSchedulesClientGetResponse added in v0.3.0 

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

RoleAssignmentSchedulesClientGetResponse contains the response from method RoleAssignmentSchedulesClient.Get.

type RoleAssignmentSchedulesClientGetResult added in v0.3.0 

type RoleAssignmentSchedulesClientGetResult struct {
	RoleAssignmentSchedule
}

RoleAssignmentSchedulesClientGetResult contains the result from method RoleAssignmentSchedulesClient.Get.

type RoleAssignmentSchedulesClientListForScopeOptions added in v0.3.0 

type RoleAssignmentSchedulesClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope.
	// Use $filter=principalId eq {id} to return all role assignment schedules at,
	// above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment
	// schedules for the current user. Use $filter=asTarget() to return all role
	// assignment schedules created for the current user.
	Filter *string
}

RoleAssignmentSchedulesClientListForScopeOptions contains the optional parameters for the RoleAssignmentSchedulesClient.ListForScope method.

type RoleAssignmentSchedulesClientListForScopePager added in v0.3.0 

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

RoleAssignmentSchedulesClientListForScopePager provides operations for iterating over paged responses.

func (*RoleAssignmentSchedulesClientListForScopePager) Err added in v0.3.0 

func (p *RoleAssignmentSchedulesClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentSchedulesClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleAssignmentSchedulesClientListForScopePager) 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 (*RoleAssignmentSchedulesClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleAssignmentSchedulesClientListForScopePager) PageResponse() RoleAssignmentSchedulesClientListForScopeResponse

PageResponse returns the current RoleAssignmentSchedulesClientListForScopeResponse page.

type RoleAssignmentSchedulesClientListForScopeResponse added in v0.3.0 

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

RoleAssignmentSchedulesClientListForScopeResponse contains the response from method RoleAssignmentSchedulesClient.ListForScope.

type RoleAssignmentSchedulesClientListForScopeResult added in v0.3.0 

type RoleAssignmentSchedulesClientListForScopeResult struct {
	RoleAssignmentScheduleListResult
}

RoleAssignmentSchedulesClientListForScopeResult contains the result from method RoleAssignmentSchedulesClient.ListForScope.

type RoleAssignmentsClient 

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

RoleAssignmentsClient contains the methods for the RoleAssignments group. Don't use this type directly, use NewRoleAssignmentsClient() instead.

func NewRoleAssignmentsClient 

func NewRoleAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RoleAssignmentsClient

NewRoleAssignmentsClient creates a new instance of RoleAssignmentsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleAssignmentsClient) Create 

func (client *RoleAssignmentsClient) Create(ctx context.Context, scope string, roleAssignmentName string, parameters RoleAssignmentCreateParameters, options *RoleAssignmentsClientCreateOptions) (RoleAssignmentsClientCreateResponse, error)

Create - Create or update a role assignment by scope and name. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' roleAssignmentName - The name of the role assignment. It can be any valid GUID. parameters - Parameters for the role assignment. options - RoleAssignmentsClientCreateOptions contains the optional parameters for the RoleAssignmentsClient.Create method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_CreateForResource.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	res, err := client.Create(ctx,
		"<scope>",
		"<role-assignment-name>",
		armauthorization.RoleAssignmentCreateParameters{
			Properties: &armauthorization.RoleAssignmentProperties{
				PrincipalID:      to.StringPtr("<principal-id>"),
				PrincipalType:    armauthorization.PrincipalType("User").ToPtr(),
				RoleDefinitionID: to.StringPtr("<role-definition-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentsClientCreateResult)
}

Output:

func (*RoleAssignmentsClient) CreateByID 

func (client *RoleAssignmentsClient) CreateByID(ctx context.Context, roleAssignmentID string, parameters RoleAssignmentCreateParameters, options *RoleAssignmentsClientCreateByIDOptions) (RoleAssignmentsClientCreateByIDResponse, error)

CreateByID - Create or update a role assignment by ID. If the operation fails it returns an *azcore.ResponseError type. roleAssignmentID - The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions//resourcegroups//providers/Microsoft.Authorization/roleAssignments/ parameters - Parameters for the role assignment. options - RoleAssignmentsClientCreateByIDOptions contains the optional parameters for the RoleAssignmentsClient.CreateByID method.

func (*RoleAssignmentsClient) Delete 

func (client *RoleAssignmentsClient) Delete(ctx context.Context, scope string, roleAssignmentName string, options *RoleAssignmentsClientDeleteOptions) (RoleAssignmentsClientDeleteResponse, error)

Delete - Delete a role assignment by scope and name. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' roleAssignmentName - The name of the role assignment. It can be any valid GUID. options - RoleAssignmentsClientDeleteOptions contains the optional parameters for the RoleAssignmentsClient.Delete method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	res, err := client.Delete(ctx,
		"<scope>",
		"<role-assignment-name>",
		&armauthorization.RoleAssignmentsClientDeleteOptions{TenantID: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentsClientDeleteResult)
}

Output:

func (*RoleAssignmentsClient) DeleteByID 

func (client *RoleAssignmentsClient) DeleteByID(ctx context.Context, roleAssignmentID string, options *RoleAssignmentsClientDeleteByIDOptions) (RoleAssignmentsClientDeleteByIDResponse, error)

DeleteByID - Delete a role assignment by ID. If the operation fails it returns an *azcore.ResponseError type. roleAssignmentID - The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions//resourcegroups//providers/Microsoft.Authorization/roleAssignments/ options - RoleAssignmentsClientDeleteByIDOptions contains the optional parameters for the RoleAssignmentsClient.DeleteByID method.

func (*RoleAssignmentsClient) Get 

func (client *RoleAssignmentsClient) Get(ctx context.Context, scope string, roleAssignmentName string, options *RoleAssignmentsClientGetOptions) (RoleAssignmentsClientGetResponse, error)

Get - Get a role assignment by scope and name. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' roleAssignmentName - The name of the role assignment. It can be any valid GUID. options - RoleAssignmentsClientGetOptions contains the optional parameters for the RoleAssignmentsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-assignment-name>",
		&armauthorization.RoleAssignmentsClientGetOptions{TenantID: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentsClientGetResult)
}

Output:

func (*RoleAssignmentsClient) GetByID 

func (client *RoleAssignmentsClient) GetByID(ctx context.Context, roleAssignmentID string, options *RoleAssignmentsClientGetByIDOptions) (RoleAssignmentsClientGetByIDResponse, error)

GetByID - Get a role assignment by ID. If the operation fails it returns an *azcore.ResponseError type. roleAssignmentID - The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions//resourcegroups//providers/Microsoft.Authorization/roleAssignments/ options - RoleAssignmentsClientGetByIDOptions contains the optional parameters for the RoleAssignmentsClient.GetByID method.

func (*RoleAssignmentsClient) ListForResource 

func (client *RoleAssignmentsClient) ListForResource(resourceGroupName string, resourceProviderNamespace string, resourceType string, resourceName string, options *RoleAssignmentsClientListForResourceOptions) *RoleAssignmentsClientListForResourcePager

ListForResource - List all role assignments that apply to a resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. resourceProviderNamespace - The namespace of the resource provider. resourceType - The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites). resourceName - The resource name. options - RoleAssignmentsClientListForResourceOptions contains the optional parameters for the RoleAssignmentsClient.ListForResource method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_ListForResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForResource("<resource-group-name>",
		"<resource-provider-namespace>",
		"<resource-type>",
		"<resource-name>",
		&armauthorization.RoleAssignmentsClientListForResourceOptions{Filter: nil,
			TenantID: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RoleAssignmentsClient) ListForResourceGroup 

func (client *RoleAssignmentsClient) ListForResourceGroup(resourceGroupName string, options *RoleAssignmentsClientListForResourceGroupOptions) *RoleAssignmentsClientListForResourceGroupPager

ListForResourceGroup - List all role assignments that apply to a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - RoleAssignmentsClientListForResourceGroupOptions contains the optional parameters for the RoleAssignmentsClient.ListForResourceGroup method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_ListForResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForResourceGroup("<resource-group-name>",
		&armauthorization.RoleAssignmentsClientListForResourceGroupOptions{Filter: nil,
			TenantID: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RoleAssignmentsClient) ListForScope 

func (client *RoleAssignmentsClient) ListForScope(scope string, options *RoleAssignmentsClientListForScopeOptions) *RoleAssignmentsClientListForScopePager

ListForScope - List all role assignments that apply to a scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' options - RoleAssignmentsClientListForScopeOptions contains the optional parameters for the RoleAssignmentsClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_ListForScope.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleAssignmentsClientListForScopeOptions{Filter: nil,
			TenantID: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RoleAssignmentsClient) ListForSubscription 

func (client *RoleAssignmentsClient) ListForSubscription(options *RoleAssignmentsClientListForSubscriptionOptions) *RoleAssignmentsClientListForSubscriptionPager

ListForSubscription - List all role assignments that apply to a subscription. If the operation fails it returns an *azcore.ResponseError type. options - RoleAssignmentsClientListForSubscriptionOptions contains the optional parameters for the RoleAssignmentsClient.ListForSubscription method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_ListForSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	pager := client.ListForSubscription(&armauthorization.RoleAssignmentsClientListForSubscriptionOptions{Filter: nil,
		TenantID: nil,
	})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RoleAssignmentsClient) Validate 

func (client *RoleAssignmentsClient) Validate(ctx context.Context, scope string, roleAssignmentName string, parameters RoleAssignmentCreateParameters, options *RoleAssignmentsClientValidateOptions) (RoleAssignmentsClientValidateResponse, error)

Validate - Validate a role assignment create or update operation by scope and name. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' roleAssignmentName - The name of the role assignment. It can be any valid GUID. parameters - Parameters for the role assignment. options - RoleAssignmentsClientValidateOptions contains the optional parameters for the RoleAssignmentsClient.Validate method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/RoleAssignments_ValidateInvalid.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleAssignmentsClient("<subscription-id>", cred, nil)
	res, err := client.Validate(ctx,
		"<scope>",
		"<role-assignment-name>",
		armauthorization.RoleAssignmentCreateParameters{
			Properties: &armauthorization.RoleAssignmentProperties{
				PrincipalID:      to.StringPtr("<principal-id>"),
				PrincipalType:    armauthorization.PrincipalType("User").ToPtr(),
				RoleDefinitionID: to.StringPtr("<role-definition-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleAssignmentsClientValidateResult)
}

Output:

func (*RoleAssignmentsClient) ValidateByID 

func (client *RoleAssignmentsClient) ValidateByID(ctx context.Context, roleAssignmentID string, parameters RoleAssignmentCreateParameters, options *RoleAssignmentsClientValidateByIDOptions) (RoleAssignmentsClientValidateByIDResponse, error)

ValidateByID - Validate a role assignment create or update operation by ID. If the operation fails it returns an *azcore.ResponseError type. roleAssignmentID - The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions//resourcegroups//providers/Microsoft.Authorization/roleAssignments/ parameters - Parameters for the role assignment. options - RoleAssignmentsClientValidateByIDOptions contains the optional parameters for the RoleAssignmentsClient.ValidateByID method.

type RoleAssignmentsClientCreateByIDOptions added in v0.3.0 

type RoleAssignmentsClientCreateByIDOptions struct {
}

RoleAssignmentsClientCreateByIDOptions contains the optional parameters for the RoleAssignmentsClient.CreateByID method.

type RoleAssignmentsClientCreateByIDResponse added in v0.3.0 

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

RoleAssignmentsClientCreateByIDResponse contains the response from method RoleAssignmentsClient.CreateByID.

type RoleAssignmentsClientCreateByIDResult added in v0.3.0 

type RoleAssignmentsClientCreateByIDResult struct {
	RoleAssignment
}

RoleAssignmentsClientCreateByIDResult contains the result from method RoleAssignmentsClient.CreateByID.

type RoleAssignmentsClientCreateOptions added in v0.3.0 

type RoleAssignmentsClientCreateOptions struct {
}

RoleAssignmentsClientCreateOptions contains the optional parameters for the RoleAssignmentsClient.Create method.

type RoleAssignmentsClientCreateResponse added in v0.3.0 

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

RoleAssignmentsClientCreateResponse contains the response from method RoleAssignmentsClient.Create.

type RoleAssignmentsClientCreateResult added in v0.3.0 

type RoleAssignmentsClientCreateResult struct {
	RoleAssignment
}

RoleAssignmentsClientCreateResult contains the result from method RoleAssignmentsClient.Create.

type RoleAssignmentsClientDeleteByIDOptions added in v0.3.0 

type RoleAssignmentsClientDeleteByIDOptions struct {
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientDeleteByIDOptions contains the optional parameters for the RoleAssignmentsClient.DeleteByID method.

type RoleAssignmentsClientDeleteByIDResponse added in v0.3.0 

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

RoleAssignmentsClientDeleteByIDResponse contains the response from method RoleAssignmentsClient.DeleteByID.

type RoleAssignmentsClientDeleteByIDResult added in v0.3.0 

type RoleAssignmentsClientDeleteByIDResult struct {
	RoleAssignment
}

RoleAssignmentsClientDeleteByIDResult contains the result from method RoleAssignmentsClient.DeleteByID.

type RoleAssignmentsClientDeleteOptions added in v0.3.0 

type RoleAssignmentsClientDeleteOptions struct {
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientDeleteOptions contains the optional parameters for the RoleAssignmentsClient.Delete method.

type RoleAssignmentsClientDeleteResponse added in v0.3.0 

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

RoleAssignmentsClientDeleteResponse contains the response from method RoleAssignmentsClient.Delete.

type RoleAssignmentsClientDeleteResult added in v0.3.0 

type RoleAssignmentsClientDeleteResult struct {
	RoleAssignment
}

RoleAssignmentsClientDeleteResult contains the result from method RoleAssignmentsClient.Delete.

type RoleAssignmentsClientGetByIDOptions added in v0.3.0 

type RoleAssignmentsClientGetByIDOptions struct {
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientGetByIDOptions contains the optional parameters for the RoleAssignmentsClient.GetByID method.

type RoleAssignmentsClientGetByIDResponse added in v0.3.0 

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

RoleAssignmentsClientGetByIDResponse contains the response from method RoleAssignmentsClient.GetByID.

type RoleAssignmentsClientGetByIDResult added in v0.3.0 

type RoleAssignmentsClientGetByIDResult struct {
	RoleAssignment
}

RoleAssignmentsClientGetByIDResult contains the result from method RoleAssignmentsClient.GetByID.

type RoleAssignmentsClientGetOptions added in v0.3.0 

type RoleAssignmentsClientGetOptions struct {
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientGetOptions contains the optional parameters for the RoleAssignmentsClient.Get method.

type RoleAssignmentsClientGetResponse added in v0.3.0 

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

RoleAssignmentsClientGetResponse contains the response from method RoleAssignmentsClient.Get.

type RoleAssignmentsClientGetResult added in v0.3.0 

type RoleAssignmentsClientGetResult struct {
	RoleAssignment
}

RoleAssignmentsClientGetResult contains the result from method RoleAssignmentsClient.Get.

type RoleAssignmentsClientListForResourceGroupOptions added in v0.3.0 

type RoleAssignmentsClientListForResourceGroupOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId
	// eq {id} to return all role assignments at, above or below the
	// scope for the specified principal.
	Filter *string
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientListForResourceGroupOptions contains the optional parameters for the RoleAssignmentsClient.ListForResourceGroup method.

type RoleAssignmentsClientListForResourceGroupPager added in v0.3.0 

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

RoleAssignmentsClientListForResourceGroupPager provides operations for iterating over paged responses.

func (*RoleAssignmentsClientListForResourceGroupPager) Err added in v0.3.0 

func (p *RoleAssignmentsClientListForResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentsClientListForResourceGroupPager) NextPage added in v0.3.0 

func (p *RoleAssignmentsClientListForResourceGroupPager) 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 (*RoleAssignmentsClientListForResourceGroupPager) PageResponse added in v0.3.0 

func (p *RoleAssignmentsClientListForResourceGroupPager) PageResponse() RoleAssignmentsClientListForResourceGroupResponse

PageResponse returns the current RoleAssignmentsClientListForResourceGroupResponse page.

type RoleAssignmentsClientListForResourceGroupResponse added in v0.3.0 

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

RoleAssignmentsClientListForResourceGroupResponse contains the response from method RoleAssignmentsClient.ListForResourceGroup.

type RoleAssignmentsClientListForResourceGroupResult added in v0.3.0 

type RoleAssignmentsClientListForResourceGroupResult struct {
	RoleAssignmentListResult
}

RoleAssignmentsClientListForResourceGroupResult contains the result from method RoleAssignmentsClient.ListForResourceGroup.

type RoleAssignmentsClientListForResourceOptions added in v0.3.0 

type RoleAssignmentsClientListForResourceOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId
	// eq {id} to return all role assignments at, above or below the
	// scope for the specified principal.
	Filter *string
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientListForResourceOptions contains the optional parameters for the RoleAssignmentsClient.ListForResource method.

type RoleAssignmentsClientListForResourcePager added in v0.3.0 

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

RoleAssignmentsClientListForResourcePager provides operations for iterating over paged responses.

func (*RoleAssignmentsClientListForResourcePager) Err added in v0.3.0 

func (p *RoleAssignmentsClientListForResourcePager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentsClientListForResourcePager) NextPage added in v0.3.0 

func (p *RoleAssignmentsClientListForResourcePager) 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 (*RoleAssignmentsClientListForResourcePager) PageResponse added in v0.3.0 

func (p *RoleAssignmentsClientListForResourcePager) PageResponse() RoleAssignmentsClientListForResourceResponse

PageResponse returns the current RoleAssignmentsClientListForResourceResponse page.

type RoleAssignmentsClientListForResourceResponse added in v0.3.0 

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

RoleAssignmentsClientListForResourceResponse contains the response from method RoleAssignmentsClient.ListForResource.

type RoleAssignmentsClientListForResourceResult added in v0.3.0 

type RoleAssignmentsClientListForResourceResult struct {
	RoleAssignmentListResult
}

RoleAssignmentsClientListForResourceResult contains the result from method RoleAssignmentsClient.ListForResource.

type RoleAssignmentsClientListForScopeOptions added in v0.3.0 

type RoleAssignmentsClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId
	// eq {id} to return all role assignments at, above or below the
	// scope for the specified principal.
	Filter *string
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientListForScopeOptions contains the optional parameters for the RoleAssignmentsClient.ListForScope method.

type RoleAssignmentsClientListForScopePager added in v0.3.0 

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

RoleAssignmentsClientListForScopePager provides operations for iterating over paged responses.

func (*RoleAssignmentsClientListForScopePager) Err added in v0.3.0 

func (p *RoleAssignmentsClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentsClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleAssignmentsClientListForScopePager) 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 (*RoleAssignmentsClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleAssignmentsClientListForScopePager) PageResponse() RoleAssignmentsClientListForScopeResponse

PageResponse returns the current RoleAssignmentsClientListForScopeResponse page.

type RoleAssignmentsClientListForScopeResponse added in v0.3.0 

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

RoleAssignmentsClientListForScopeResponse contains the response from method RoleAssignmentsClient.ListForScope.

type RoleAssignmentsClientListForScopeResult added in v0.3.0 

type RoleAssignmentsClientListForScopeResult struct {
	RoleAssignmentListResult
}

RoleAssignmentsClientListForScopeResult contains the result from method RoleAssignmentsClient.ListForScope.

type RoleAssignmentsClientListForSubscriptionOptions added in v0.3.0 

type RoleAssignmentsClientListForSubscriptionOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId
	// eq {id} to return all role assignments at, above or below the
	// scope for the specified principal.
	Filter *string
	// Tenant ID for cross-tenant request
	TenantID *string
}

RoleAssignmentsClientListForSubscriptionOptions contains the optional parameters for the RoleAssignmentsClient.ListForSubscription method.

type RoleAssignmentsClientListForSubscriptionPager added in v0.3.0 

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

RoleAssignmentsClientListForSubscriptionPager provides operations for iterating over paged responses.

func (*RoleAssignmentsClientListForSubscriptionPager) Err added in v0.3.0 

func (p *RoleAssignmentsClientListForSubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*RoleAssignmentsClientListForSubscriptionPager) NextPage added in v0.3.0 

func (p *RoleAssignmentsClientListForSubscriptionPager) 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 (*RoleAssignmentsClientListForSubscriptionPager) PageResponse added in v0.3.0 

func (p *RoleAssignmentsClientListForSubscriptionPager) PageResponse() RoleAssignmentsClientListForSubscriptionResponse

PageResponse returns the current RoleAssignmentsClientListForSubscriptionResponse page.

type RoleAssignmentsClientListForSubscriptionResponse added in v0.3.0 

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

RoleAssignmentsClientListForSubscriptionResponse contains the response from method RoleAssignmentsClient.ListForSubscription.

type RoleAssignmentsClientListForSubscriptionResult added in v0.3.0 

type RoleAssignmentsClientListForSubscriptionResult struct {
	RoleAssignmentListResult
}

RoleAssignmentsClientListForSubscriptionResult contains the result from method RoleAssignmentsClient.ListForSubscription.

type RoleAssignmentsClientValidateByIDOptions added in v0.3.0 

type RoleAssignmentsClientValidateByIDOptions struct {
}

RoleAssignmentsClientValidateByIDOptions contains the optional parameters for the RoleAssignmentsClient.ValidateByID method.

type RoleAssignmentsClientValidateByIDResponse added in v0.3.0 

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

RoleAssignmentsClientValidateByIDResponse contains the response from method RoleAssignmentsClient.ValidateByID.

type RoleAssignmentsClientValidateByIDResult added in v0.3.0 

type RoleAssignmentsClientValidateByIDResult struct {
	ValidationResponse
}

RoleAssignmentsClientValidateByIDResult contains the result from method RoleAssignmentsClient.ValidateByID.

type RoleAssignmentsClientValidateOptions added in v0.3.0 

type RoleAssignmentsClientValidateOptions struct {
}

RoleAssignmentsClientValidateOptions contains the optional parameters for the RoleAssignmentsClient.Validate method.

type RoleAssignmentsClientValidateResponse added in v0.3.0 

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

RoleAssignmentsClientValidateResponse contains the response from method RoleAssignmentsClient.Validate.

type RoleAssignmentsClientValidateResult added in v0.3.0 

type RoleAssignmentsClientValidateResult struct {
	ValidationResponse
}

RoleAssignmentsClientValidateResult contains the result from method RoleAssignmentsClient.Validate.

type RoleDefinition 

type RoleDefinition struct {
	// Role definition properties.
	Properties *RoleDefinitionProperties `json:"properties,omitempty"`

	// READ-ONLY; The role definition ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role definition name.
	Name *string `json:"name,omitempty" azure:"ro"`

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

RoleDefinition - Role definition.

type RoleDefinitionFilter 

type RoleDefinitionFilter struct {
	// Returns role definition with the specific name.
	RoleName *string `json:"roleName,omitempty"`

	// Returns role definition with the specific type.
	Type *string `json:"type,omitempty"`
}

RoleDefinitionFilter - Role Definitions filter

type RoleDefinitionListResult 

type RoleDefinitionListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role definition list.
	Value []*RoleDefinition `json:"value,omitempty"`
}

RoleDefinitionListResult - Role definition list operation result.

func (RoleDefinitionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleDefinitionListResult.

type RoleDefinitionProperties 

type RoleDefinitionProperties struct {
	// Role definition assignable scopes.
	AssignableScopes []*string `json:"assignableScopes,omitempty"`

	// The role definition description.
	Description *string `json:"description,omitempty"`

	// Role definition permissions.
	Permissions []*Permission `json:"permissions,omitempty"`

	// The role name.
	RoleName *string `json:"roleName,omitempty"`

	// The role type.
	RoleType *string `json:"type,omitempty"`
}

RoleDefinitionProperties - Role definition properties.

func (RoleDefinitionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleDefinitionProperties.

type RoleDefinitionsClient 

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

RoleDefinitionsClient contains the methods for the RoleDefinitions group. Don't use this type directly, use NewRoleDefinitionsClient() instead.

func NewRoleDefinitionsClient 

func NewRoleDefinitionsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleDefinitionsClient

NewRoleDefinitionsClient creates a new instance of RoleDefinitionsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleDefinitionsClient) CreateOrUpdate 

func (client *RoleDefinitionsClient) CreateOrUpdate(ctx context.Context, scope string, roleDefinitionID string, roleDefinition RoleDefinition, options *RoleDefinitionsClientCreateOrUpdateOptions) (RoleDefinitionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a role definition. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role definition. roleDefinitionID - The ID of the role definition. roleDefinition - The values for the role definition. options - RoleDefinitionsClientCreateOrUpdateOptions contains the optional parameters for the RoleDefinitionsClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/PutRoleDefinition.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleDefinitionsClient(cred, nil)
	_, err = client.CreateOrUpdate(ctx,
		"<scope>",
		"<role-definition-id>",
		armauthorization.RoleDefinition{},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleDefinitionsClient) Delete 

func (client *RoleDefinitionsClient) Delete(ctx context.Context, scope string, roleDefinitionID string, options *RoleDefinitionsClientDeleteOptions) (RoleDefinitionsClientDeleteResponse, error)

Delete - Deletes a role definition. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role definition. roleDefinitionID - The ID of the role definition to delete. options - RoleDefinitionsClientDeleteOptions contains the optional parameters for the RoleDefinitionsClient.Delete method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/DeleteRoleDefinition.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleDefinitionsClient(cred, nil)
	res, err := client.Delete(ctx,
		"<scope>",
		"<role-definition-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleDefinitionsClientDeleteResult)
}

Output:

func (*RoleDefinitionsClient) Get 

func (client *RoleDefinitionsClient) Get(ctx context.Context, scope string, roleDefinitionID string, options *RoleDefinitionsClientGetOptions) (RoleDefinitionsClientGetResponse, error)

Get - Get role definition by name (GUID). If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role definition. roleDefinitionID - The ID of the role definition. options - RoleDefinitionsClientGetOptions contains the optional parameters for the RoleDefinitionsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/GetRoleDefinitionByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleDefinitionsClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-definition-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleDefinitionsClientGetResult)
}

Output:

func (*RoleDefinitionsClient) GetByID 

func (client *RoleDefinitionsClient) GetByID(ctx context.Context, roleID string, options *RoleDefinitionsClientGetByIDOptions) (RoleDefinitionsClientGetByIDResponse, error)

GetByID - Gets a role definition by ID. If the operation fails it returns an *azcore.ResponseError type. roleID - The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions. options - RoleDefinitionsClientGetByIDOptions contains the optional parameters for the RoleDefinitionsClient.GetByID method.

func (*RoleDefinitionsClient) List 

func (client *RoleDefinitionsClient) List(scope string, options *RoleDefinitionsClientListOptions) *RoleDefinitionsClientListPager

List - Get all role definitions that are applicable at scope and above. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role definition. options - RoleDefinitionsClientListOptions contains the optional parameters for the RoleDefinitionsClient.List method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/examples/GetRoleDefinitionAtScope.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleDefinitionsClient(cred, nil)
	pager := client.List("<scope>",
		&armauthorization.RoleDefinitionsClientListOptions{Filter: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleDefinitionsClientCreateOrUpdateOptions added in v0.3.0 

type RoleDefinitionsClientCreateOrUpdateOptions struct {
}

RoleDefinitionsClientCreateOrUpdateOptions contains the optional parameters for the RoleDefinitionsClient.CreateOrUpdate method.

type RoleDefinitionsClientCreateOrUpdateResponse added in v0.3.0 

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

RoleDefinitionsClientCreateOrUpdateResponse contains the response from method RoleDefinitionsClient.CreateOrUpdate.

type RoleDefinitionsClientCreateOrUpdateResult added in v0.3.0 

type RoleDefinitionsClientCreateOrUpdateResult struct {
	RoleDefinition
}

RoleDefinitionsClientCreateOrUpdateResult contains the result from method RoleDefinitionsClient.CreateOrUpdate.

type RoleDefinitionsClientDeleteOptions added in v0.3.0 

type RoleDefinitionsClientDeleteOptions struct {
}

RoleDefinitionsClientDeleteOptions contains the optional parameters for the RoleDefinitionsClient.Delete method.

type RoleDefinitionsClientDeleteResponse added in v0.3.0 

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

RoleDefinitionsClientDeleteResponse contains the response from method RoleDefinitionsClient.Delete.

type RoleDefinitionsClientDeleteResult added in v0.3.0 

type RoleDefinitionsClientDeleteResult struct {
	RoleDefinition
}

RoleDefinitionsClientDeleteResult contains the result from method RoleDefinitionsClient.Delete.

type RoleDefinitionsClientGetByIDOptions added in v0.3.0 

type RoleDefinitionsClientGetByIDOptions struct {
}

RoleDefinitionsClientGetByIDOptions contains the optional parameters for the RoleDefinitionsClient.GetByID method.

type RoleDefinitionsClientGetByIDResponse added in v0.3.0 

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

RoleDefinitionsClientGetByIDResponse contains the response from method RoleDefinitionsClient.GetByID.

type RoleDefinitionsClientGetByIDResult added in v0.3.0 

type RoleDefinitionsClientGetByIDResult struct {
	RoleDefinition
}

RoleDefinitionsClientGetByIDResult contains the result from method RoleDefinitionsClient.GetByID.

type RoleDefinitionsClientGetOptions added in v0.3.0 

type RoleDefinitionsClientGetOptions struct {
}

RoleDefinitionsClientGetOptions contains the optional parameters for the RoleDefinitionsClient.Get method.

type RoleDefinitionsClientGetResponse added in v0.3.0 

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

RoleDefinitionsClientGetResponse contains the response from method RoleDefinitionsClient.Get.

type RoleDefinitionsClientGetResult added in v0.3.0 

type RoleDefinitionsClientGetResult struct {
	RoleDefinition
}

RoleDefinitionsClientGetResult contains the result from method RoleDefinitionsClient.Get.

type RoleDefinitionsClientListOptions added in v0.3.0 

type RoleDefinitionsClientListOptions struct {
	// The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.
	Filter *string
}

RoleDefinitionsClientListOptions contains the optional parameters for the RoleDefinitionsClient.List method.

type RoleDefinitionsClientListPager added in v0.3.0 

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

RoleDefinitionsClientListPager provides operations for iterating over paged responses.

func (*RoleDefinitionsClientListPager) Err added in v0.3.0 

func (p *RoleDefinitionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*RoleDefinitionsClientListPager) NextPage added in v0.3.0 

func (p *RoleDefinitionsClientListPager) 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 (*RoleDefinitionsClientListPager) PageResponse added in v0.3.0 

func (p *RoleDefinitionsClientListPager) PageResponse() RoleDefinitionsClientListResponse

PageResponse returns the current RoleDefinitionsClientListResponse page.

type RoleDefinitionsClientListResponse added in v0.3.0 

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

RoleDefinitionsClientListResponse contains the response from method RoleDefinitionsClient.List.

type RoleDefinitionsClientListResult added in v0.3.0 

type RoleDefinitionsClientListResult struct {
	RoleDefinitionListResult
}

RoleDefinitionsClientListResult contains the result from method RoleDefinitionsClient.List.

type RoleEligibilitySchedule 

type RoleEligibilitySchedule struct {
	// role eligibility schedule properties.
	Properties *RoleEligibilityScheduleProperties `json:"properties,omitempty"`

	// READ-ONLY; The role eligibility schedule Id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleEligibilitySchedule - Role eligibility schedule

type RoleEligibilityScheduleFilter 

type RoleEligibilityScheduleFilter struct {
	// Returns role eligibility schedule of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`

	// Returns role eligibility schedule of the specific role definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Returns role eligibility schedule of the specific status.
	Status *string `json:"status,omitempty"`
}

RoleEligibilityScheduleFilter - Role eligibility schedule filter

type RoleEligibilityScheduleInstance 

type RoleEligibilityScheduleInstance struct {
	// Role eligibility schedule instance properties.
	Properties *RoleEligibilityScheduleInstanceProperties `json:"properties,omitempty"`

	// READ-ONLY; The role eligibility schedule instance ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule instance name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule instance type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleEligibilityScheduleInstance - Information about current or upcoming role eligibility schedule instance

type RoleEligibilityScheduleInstanceFilter 

type RoleEligibilityScheduleInstanceFilter struct {
	// Returns role eligibility schedule instances of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`

	// Returns role eligibility schedule instances of the specific role definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Returns role eligibility schedule instances belonging to a specific role eligibility schedule.
	RoleEligibilityScheduleID *string `json:"roleEligibilityScheduleId,omitempty"`

	// Returns role eligibility schedule instances of the specific status.
	Status *string `json:"status,omitempty"`
}

RoleEligibilityScheduleInstanceFilter - Role eligibility schedule instance filter

type RoleEligibilityScheduleInstanceListResult 

type RoleEligibilityScheduleInstanceListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role eligibility schedule instance list.
	Value []*RoleEligibilityScheduleInstance `json:"value,omitempty"`
}

RoleEligibilityScheduleInstanceListResult - Role eligibility schedule instance list operation result.

func (RoleEligibilityScheduleInstanceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleInstanceListResult.

type RoleEligibilityScheduleInstanceProperties 

type RoleEligibilityScheduleInstanceProperties struct {
	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// DateTime when role eligibility schedule was created
	CreatedOn *time.Time `json:"createdOn,omitempty"`

	// The endDateTime of the role eligibility schedule instance
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// Additional properties of principal, scope and role definition
	ExpandedProperties *ExpandedProperties `json:"expandedProperties,omitempty"`

	// Membership type of the role eligibility schedule
	MemberType *MemberType `json:"memberType,omitempty"`

	// The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty"`

	// The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Id of the master role eligibility schedule
	RoleEligibilityScheduleID *string `json:"roleEligibilityScheduleId,omitempty"`

	// The role eligibility schedule scope.
	Scope *string `json:"scope,omitempty"`

	// The startDateTime of the role eligibility schedule instance
	StartDateTime *time.Time `json:"startDateTime,omitempty"`

	// The status of the role eligibility schedule instance
	Status *Status `json:"status,omitempty"`
}

RoleEligibilityScheduleInstanceProperties - Role eligibility schedule properties with scope.

func (RoleEligibilityScheduleInstanceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleInstanceProperties.

func (*RoleEligibilityScheduleInstanceProperties) UnmarshalJSON 

func (r *RoleEligibilityScheduleInstanceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleEligibilityScheduleInstanceProperties.

type RoleEligibilityScheduleInstancesClient 

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

RoleEligibilityScheduleInstancesClient contains the methods for the RoleEligibilityScheduleInstances group. Don't use this type directly, use NewRoleEligibilityScheduleInstancesClient() instead.

func NewRoleEligibilityScheduleInstancesClient 

func NewRoleEligibilityScheduleInstancesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleEligibilityScheduleInstancesClient

NewRoleEligibilityScheduleInstancesClient creates a new instance of RoleEligibilityScheduleInstancesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleEligibilityScheduleInstancesClient) Get 

func (client *RoleEligibilityScheduleInstancesClient) Get(ctx context.Context, scope string, roleEligibilityScheduleInstanceName string, options *RoleEligibilityScheduleInstancesClientGetOptions) (RoleEligibilityScheduleInstancesClientGetResponse, error)

Get - Gets the specified role eligibility schedule instance. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedules. roleEligibilityScheduleInstanceName - The name (hash of schedule name + time) of the role eligibility schedule to get. options - RoleEligibilityScheduleInstancesClientGetOptions contains the optional parameters for the RoleEligibilityScheduleInstancesClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilityScheduleInstancesClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-eligibility-schedule-instance-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleEligibilityScheduleInstancesClientGetResult)
}

Output:

func (*RoleEligibilityScheduleInstancesClient) ListForScope 

func (client *RoleEligibilityScheduleInstancesClient) ListForScope(scope string, options *RoleEligibilityScheduleInstancesClientListForScopeOptions) *RoleEligibilityScheduleInstancesClientListForScopePager

ListForScope - Gets role eligibility schedule instances of a role eligibility schedule. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedule. options - RoleEligibilityScheduleInstancesClientListForScopeOptions contains the optional parameters for the RoleEligibilityScheduleInstancesClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilityScheduleInstancesClient(cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleEligibilityScheduleInstancesClientListForScopeOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleEligibilityScheduleInstancesClientGetOptions added in v0.3.0 

type RoleEligibilityScheduleInstancesClientGetOptions struct {
}

RoleEligibilityScheduleInstancesClientGetOptions contains the optional parameters for the RoleEligibilityScheduleInstancesClient.Get method.

type RoleEligibilityScheduleInstancesClientGetResponse added in v0.3.0 

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

RoleEligibilityScheduleInstancesClientGetResponse contains the response from method RoleEligibilityScheduleInstancesClient.Get.

type RoleEligibilityScheduleInstancesClientGetResult added in v0.3.0 

type RoleEligibilityScheduleInstancesClientGetResult struct {
	RoleEligibilityScheduleInstance
}

RoleEligibilityScheduleInstancesClientGetResult contains the result from method RoleEligibilityScheduleInstancesClient.Get.

type RoleEligibilityScheduleInstancesClientListForScopeOptions added in v0.3.0 

type RoleEligibilityScheduleInstancesClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope.
	// Use $filter=principalId eq {id} to return all role assignment schedules at,
	// above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility
	// schedules for the user. Use $filter=asTarget() to return all role eligibility
	// schedules created for the current user.
	Filter *string
}

RoleEligibilityScheduleInstancesClientListForScopeOptions contains the optional parameters for the RoleEligibilityScheduleInstancesClient.ListForScope method.

type RoleEligibilityScheduleInstancesClientListForScopePager added in v0.3.0 

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

RoleEligibilityScheduleInstancesClientListForScopePager provides operations for iterating over paged responses.

func (*RoleEligibilityScheduleInstancesClientListForScopePager) Err added in v0.3.0 

func (p *RoleEligibilityScheduleInstancesClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleEligibilityScheduleInstancesClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleEligibilityScheduleInstancesClientListForScopePager) 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 (*RoleEligibilityScheduleInstancesClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleEligibilityScheduleInstancesClientListForScopePager) PageResponse() RoleEligibilityScheduleInstancesClientListForScopeResponse

PageResponse returns the current RoleEligibilityScheduleInstancesClientListForScopeResponse page.

type RoleEligibilityScheduleInstancesClientListForScopeResponse added in v0.3.0 

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

RoleEligibilityScheduleInstancesClientListForScopeResponse contains the response from method RoleEligibilityScheduleInstancesClient.ListForScope.

type RoleEligibilityScheduleInstancesClientListForScopeResult added in v0.3.0 

type RoleEligibilityScheduleInstancesClientListForScopeResult struct {
	RoleEligibilityScheduleInstanceListResult
}

RoleEligibilityScheduleInstancesClientListForScopeResult contains the result from method RoleEligibilityScheduleInstancesClient.ListForScope.

type RoleEligibilityScheduleListResult 

type RoleEligibilityScheduleListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// role eligibility schedule list.
	Value []*RoleEligibilitySchedule `json:"value,omitempty"`
}

RoleEligibilityScheduleListResult - role eligibility schedule list operation result.

func (RoleEligibilityScheduleListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleListResult.

type RoleEligibilityScheduleProperties 

type RoleEligibilityScheduleProperties struct {
	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// DateTime when role eligibility schedule was created
	CreatedOn *time.Time `json:"createdOn,omitempty"`

	// End DateTime when role eligibility schedule
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// Additional properties of principal, scope and role definition
	ExpandedProperties *ExpandedProperties `json:"expandedProperties,omitempty"`

	// Membership type of the role eligibility schedule
	MemberType *MemberType `json:"memberType,omitempty"`

	// The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty"`

	// The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule
	RoleEligibilityScheduleRequestID *string `json:"roleEligibilityScheduleRequestId,omitempty"`

	// The role eligibility schedule scope.
	Scope *string `json:"scope,omitempty"`

	// Start DateTime when role eligibility schedule
	StartDateTime *time.Time `json:"startDateTime,omitempty"`

	// The status of the role eligibility schedule.
	Status *Status `json:"status,omitempty"`

	// DateTime when role eligibility schedule was modified
	UpdatedOn *time.Time `json:"updatedOn,omitempty"`
}

RoleEligibilityScheduleProperties - Role eligibility schedule properties with scope.

func (RoleEligibilityScheduleProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleProperties.

func (*RoleEligibilityScheduleProperties) UnmarshalJSON 

func (r *RoleEligibilityScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleEligibilityScheduleProperties.

type RoleEligibilityScheduleRequest 

type RoleEligibilityScheduleRequest struct {
	// Role eligibility schedule request properties.
	Properties *RoleEligibilityScheduleRequestProperties `json:"properties,omitempty"`

	// READ-ONLY; The role eligibility schedule request ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule request name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule request type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleEligibilityScheduleRequest - Role Eligibility schedule request

type RoleEligibilityScheduleRequestFilter 

type RoleEligibilityScheduleRequestFilter struct {
	// Returns role eligibility requests of the specific principal.
	PrincipalID *string `json:"principalId,omitempty"`

	// Returns role eligibility requests created by specific principal.
	RequestorID *string `json:"requestorId,omitempty"`

	// Returns role eligibility requests of the specific role definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// Returns role eligibility requests of specific status.
	Status *string `json:"status,omitempty"`
}

RoleEligibilityScheduleRequestFilter - Role eligibility schedule request filter

type RoleEligibilityScheduleRequestListResult 

type RoleEligibilityScheduleRequestListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role eligibility schedule request list.
	Value []*RoleEligibilityScheduleRequest `json:"value,omitempty"`
}

RoleEligibilityScheduleRequestListResult - Role eligibility schedule request list operation result.

func (RoleEligibilityScheduleRequestListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleRequestListResult.

type RoleEligibilityScheduleRequestProperties 

type RoleEligibilityScheduleRequestProperties struct {
	// REQUIRED; The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`

	// REQUIRED; The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc
	RequestType *RequestType `json:"requestType,omitempty"`

	// REQUIRED; The role definition ID.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]
	// StringEqualsIgnoreCase
	// 'foostoragecontainer'
	Condition *string `json:"condition,omitempty"`

	// Version of the condition. Currently accepted value is '2.0'
	ConditionVersion *string `json:"conditionVersion,omitempty"`

	// Justification for the role eligibility
	Justification *string `json:"justification,omitempty"`

	// Schedule info of the role eligibility schedule
	ScheduleInfo *RoleEligibilityScheduleRequestPropertiesScheduleInfo `json:"scheduleInfo,omitempty"`

	// The resultant role eligibility schedule id or the role eligibility schedule id being updated
	TargetRoleEligibilityScheduleID *string `json:"targetRoleEligibilityScheduleId,omitempty"`

	// The role eligibility schedule instance id being updated
	TargetRoleEligibilityScheduleInstanceID *string `json:"targetRoleEligibilityScheduleInstanceId,omitempty"`

	// Ticket Info of the role eligibility
	TicketInfo *RoleEligibilityScheduleRequestPropertiesTicketInfo `json:"ticketInfo,omitempty"`

	// READ-ONLY; The approvalId of the role eligibility schedule request.
	ApprovalID *string `json:"approvalId,omitempty" azure:"ro"`

	// READ-ONLY; DateTime when role eligibility schedule request was created
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Additional properties of principal, scope and role definition
	ExpandedProperties *ExpandedProperties `json:"expandedProperties,omitempty" azure:"ro"`

	// READ-ONLY; The principal type of the assigned principal ID.
	PrincipalType *PrincipalType `json:"principalType,omitempty" azure:"ro"`

	// READ-ONLY; Id of the user who created this request
	RequestorID *string `json:"requestorId,omitempty" azure:"ro"`

	// READ-ONLY; The role eligibility schedule request scope.
	Scope *string `json:"scope,omitempty" azure:"ro"`

	// READ-ONLY; The status of the role eligibility schedule request.
	Status *Status `json:"status,omitempty" azure:"ro"`
}

RoleEligibilityScheduleRequestProperties - Role eligibility schedule request properties with scope.

func (RoleEligibilityScheduleRequestProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleRequestProperties.

func (*RoleEligibilityScheduleRequestProperties) UnmarshalJSON 

func (r *RoleEligibilityScheduleRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleEligibilityScheduleRequestProperties.

type RoleEligibilityScheduleRequestPropertiesScheduleInfo 

type RoleEligibilityScheduleRequestPropertiesScheduleInfo struct {
	// Expiration of the role eligibility schedule
	Expiration *RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration `json:"expiration,omitempty"`

	// Start DateTime of the role eligibility schedule.
	StartDateTime *time.Time `json:"startDateTime,omitempty"`
}

RoleEligibilityScheduleRequestPropertiesScheduleInfo - Schedule info of the role eligibility schedule

func (RoleEligibilityScheduleRequestPropertiesScheduleInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleRequestPropertiesScheduleInfo.

func (*RoleEligibilityScheduleRequestPropertiesScheduleInfo) UnmarshalJSON 

func (r *RoleEligibilityScheduleRequestPropertiesScheduleInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleEligibilityScheduleRequestPropertiesScheduleInfo.

type RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration 

type RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration struct {
	// Duration of the role eligibility schedule in TimeSpan.
	Duration *string `json:"duration,omitempty"`

	// End DateTime of the role eligibility schedule.
	EndDateTime *time.Time `json:"endDateTime,omitempty"`

	// Type of the role eligibility schedule expiration
	Type *Type `json:"type,omitempty"`
}

RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration - Expiration of the role eligibility schedule

func (RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration.

func (*RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) UnmarshalJSON 

func (r *RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration.

type RoleEligibilityScheduleRequestPropertiesTicketInfo 

type RoleEligibilityScheduleRequestPropertiesTicketInfo struct {
	// Ticket number for the role eligibility
	TicketNumber *string `json:"ticketNumber,omitempty"`

	// Ticket system name for the role eligibility
	TicketSystem *string `json:"ticketSystem,omitempty"`
}

RoleEligibilityScheduleRequestPropertiesTicketInfo - Ticket Info of the role eligibility

type RoleEligibilityScheduleRequestsClient 

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

RoleEligibilityScheduleRequestsClient contains the methods for the RoleEligibilityScheduleRequests group. Don't use this type directly, use NewRoleEligibilityScheduleRequestsClient() instead.

func NewRoleEligibilityScheduleRequestsClient 

func NewRoleEligibilityScheduleRequestsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleEligibilityScheduleRequestsClient

NewRoleEligibilityScheduleRequestsClient creates a new instance of RoleEligibilityScheduleRequestsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleEligibilityScheduleRequestsClient) Cancel 

func (client *RoleEligibilityScheduleRequestsClient) Cancel(ctx context.Context, scope string, roleEligibilityScheduleRequestName string, options *RoleEligibilityScheduleRequestsClientCancelOptions) (RoleEligibilityScheduleRequestsClientCancelResponse, error)

Cancel - Cancels a pending role eligibility schedule request. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility request to cancel. roleEligibilityScheduleRequestName - The name of the role eligibility request to cancel. options - RoleEligibilityScheduleRequestsClientCancelOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.Cancel method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilityScheduleRequestsClient(cred, nil)
	_, err = client.Cancel(ctx,
		"<scope>",
		"<role-eligibility-schedule-request-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleEligibilityScheduleRequestsClient) Create 

func (client *RoleEligibilityScheduleRequestsClient) Create(ctx context.Context, scope string, roleEligibilityScheduleRequestName string, parameters RoleEligibilityScheduleRequest, options *RoleEligibilityScheduleRequestsClientCreateOptions) (RoleEligibilityScheduleRequestsClientCreateResponse, error)

Create - Creates a role eligibility schedule request. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource. roleEligibilityScheduleRequestName - The name of the role eligibility to create. It can be any valid GUID. parameters - Parameters for the role eligibility schedule request. options - RoleEligibilityScheduleRequestsClientCreateOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.Create method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/PutRoleEligibilityScheduleRequest.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilityScheduleRequestsClient(cred, nil)
	_, err = client.Create(ctx,
		"<scope>",
		"<role-eligibility-schedule-request-name>",
		armauthorization.RoleEligibilityScheduleRequest{
			Properties: &armauthorization.RoleEligibilityScheduleRequestProperties{
				Condition:        to.StringPtr("<condition>"),
				ConditionVersion: to.StringPtr("<condition-version>"),
				PrincipalID:      to.StringPtr("<principal-id>"),
				RequestType:      armauthorization.RequestType("AdminAssign").ToPtr(),
				RoleDefinitionID: to.StringPtr("<role-definition-id>"),
				ScheduleInfo: &armauthorization.RoleEligibilityScheduleRequestPropertiesScheduleInfo{
					Expiration: &armauthorization.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration{
						Type:     armauthorization.Type("AfterDuration").ToPtr(),
						Duration: to.StringPtr("<duration>"),
					},
					StartDateTime: to.TimePtr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:31:27.91Z"); return t }()),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleEligibilityScheduleRequestsClient) Get 

func (client *RoleEligibilityScheduleRequestsClient) Get(ctx context.Context, scope string, roleEligibilityScheduleRequestName string, options *RoleEligibilityScheduleRequestsClientGetOptions) (RoleEligibilityScheduleRequestsClientGetResponse, error)

Get - Get the specified role eligibility schedule request. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedule request. roleEligibilityScheduleRequestName - The name (guid) of the role eligibility schedule request to get. options - RoleEligibilityScheduleRequestsClientGetOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilityScheduleRequestsClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-eligibility-schedule-request-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleEligibilityScheduleRequestsClientGetResult)
}

Output:

func (*RoleEligibilityScheduleRequestsClient) ListForScope 

func (client *RoleEligibilityScheduleRequestsClient) ListForScope(scope string, options *RoleEligibilityScheduleRequestsClientListForScopeOptions) *RoleEligibilityScheduleRequestsClientListForScopePager

ListForScope - Gets role eligibility schedule requests for a scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedule requests. options - RoleEligibilityScheduleRequestsClientListForScopeOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilityScheduleRequestsClient(cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleEligibilityScheduleRequestsClientListForScopeOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleEligibilityScheduleRequestsClientCancelOptions added in v0.3.0 

type RoleEligibilityScheduleRequestsClientCancelOptions struct {
}

RoleEligibilityScheduleRequestsClientCancelOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.Cancel method.

type RoleEligibilityScheduleRequestsClientCancelResponse added in v0.3.0 

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

RoleEligibilityScheduleRequestsClientCancelResponse contains the response from method RoleEligibilityScheduleRequestsClient.Cancel.

type RoleEligibilityScheduleRequestsClientCreateOptions added in v0.3.0 

type RoleEligibilityScheduleRequestsClientCreateOptions struct {
}

RoleEligibilityScheduleRequestsClientCreateOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.Create method.

type RoleEligibilityScheduleRequestsClientCreateResponse added in v0.3.0 

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

RoleEligibilityScheduleRequestsClientCreateResponse contains the response from method RoleEligibilityScheduleRequestsClient.Create.

type RoleEligibilityScheduleRequestsClientCreateResult added in v0.3.0 

type RoleEligibilityScheduleRequestsClientCreateResult struct {
	RoleEligibilityScheduleRequest
}

RoleEligibilityScheduleRequestsClientCreateResult contains the result from method RoleEligibilityScheduleRequestsClient.Create.

type RoleEligibilityScheduleRequestsClientGetOptions added in v0.3.0 

type RoleEligibilityScheduleRequestsClientGetOptions struct {
}

RoleEligibilityScheduleRequestsClientGetOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.Get method.

type RoleEligibilityScheduleRequestsClientGetResponse added in v0.3.0 

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

RoleEligibilityScheduleRequestsClientGetResponse contains the response from method RoleEligibilityScheduleRequestsClient.Get.

type RoleEligibilityScheduleRequestsClientGetResult added in v0.3.0 

type RoleEligibilityScheduleRequestsClientGetResult struct {
	RoleEligibilityScheduleRequest
}

RoleEligibilityScheduleRequestsClientGetResult contains the result from method RoleEligibilityScheduleRequestsClient.Get.

type RoleEligibilityScheduleRequestsClientListForScopeOptions added in v0.3.0 

type RoleEligibilityScheduleRequestsClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above
	// the scope. Use $filter=principalId eq {id} to return all role eligibility
	// schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role
	// eligibility schedule requests requested by the current user. Use
	// $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover()
	// to return all role eligibility schedule requests where the current user is an
	// approver.
	Filter *string
}

RoleEligibilityScheduleRequestsClientListForScopeOptions contains the optional parameters for the RoleEligibilityScheduleRequestsClient.ListForScope method.

type RoleEligibilityScheduleRequestsClientListForScopePager added in v0.3.0 

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

RoleEligibilityScheduleRequestsClientListForScopePager provides operations for iterating over paged responses.

func (*RoleEligibilityScheduleRequestsClientListForScopePager) Err added in v0.3.0 

func (p *RoleEligibilityScheduleRequestsClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleEligibilityScheduleRequestsClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleEligibilityScheduleRequestsClientListForScopePager) 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 (*RoleEligibilityScheduleRequestsClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleEligibilityScheduleRequestsClientListForScopePager) PageResponse() RoleEligibilityScheduleRequestsClientListForScopeResponse

PageResponse returns the current RoleEligibilityScheduleRequestsClientListForScopeResponse page.

type RoleEligibilityScheduleRequestsClientListForScopeResponse added in v0.3.0 

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

RoleEligibilityScheduleRequestsClientListForScopeResponse contains the response from method RoleEligibilityScheduleRequestsClient.ListForScope.

type RoleEligibilityScheduleRequestsClientListForScopeResult added in v0.3.0 

type RoleEligibilityScheduleRequestsClientListForScopeResult struct {
	RoleEligibilityScheduleRequestListResult
}

RoleEligibilityScheduleRequestsClientListForScopeResult contains the result from method RoleEligibilityScheduleRequestsClient.ListForScope.

type RoleEligibilitySchedulesClient 

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

RoleEligibilitySchedulesClient contains the methods for the RoleEligibilitySchedules group. Don't use this type directly, use NewRoleEligibilitySchedulesClient() instead.

func NewRoleEligibilitySchedulesClient 

func NewRoleEligibilitySchedulesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleEligibilitySchedulesClient

NewRoleEligibilitySchedulesClient creates a new instance of RoleEligibilitySchedulesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleEligibilitySchedulesClient) Get 

func (client *RoleEligibilitySchedulesClient) Get(ctx context.Context, scope string, roleEligibilityScheduleName string, options *RoleEligibilitySchedulesClientGetOptions) (RoleEligibilitySchedulesClientGetResponse, error)

Get - Get the specified role eligibility schedule for a resource scope If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedule. roleEligibilityScheduleName - The name (guid) of the role eligibility schedule to get. options - RoleEligibilitySchedulesClientGetOptions contains the optional parameters for the RoleEligibilitySchedulesClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleEligibilityScheduleByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilitySchedulesClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-eligibility-schedule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleEligibilitySchedulesClientGetResult)
}

Output:

func (*RoleEligibilitySchedulesClient) ListForScope 

func (client *RoleEligibilitySchedulesClient) ListForScope(scope string, options *RoleEligibilitySchedulesClientListForScopeOptions) *RoleEligibilitySchedulesClientListForScopePager

ListForScope - Gets role eligibility schedules for a resource scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role eligibility schedules. options - RoleEligibilitySchedulesClientListForScopeOptions contains the optional parameters for the RoleEligibilitySchedulesClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleEligibilitySchedulesByScope.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleEligibilitySchedulesClient(cred, nil)
	pager := client.ListForScope("<scope>",
		&armauthorization.RoleEligibilitySchedulesClientListForScopeOptions{Filter: to.StringPtr("<filter>")})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleEligibilitySchedulesClientGetOptions added in v0.3.0 

type RoleEligibilitySchedulesClientGetOptions struct {
}

RoleEligibilitySchedulesClientGetOptions contains the optional parameters for the RoleEligibilitySchedulesClient.Get method.

type RoleEligibilitySchedulesClientGetResponse added in v0.3.0 

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

RoleEligibilitySchedulesClientGetResponse contains the response from method RoleEligibilitySchedulesClient.Get.

type RoleEligibilitySchedulesClientGetResult added in v0.3.0 

type RoleEligibilitySchedulesClientGetResult struct {
	RoleEligibilitySchedule
}

RoleEligibilitySchedulesClientGetResult contains the result from method RoleEligibilitySchedulesClient.Get.

type RoleEligibilitySchedulesClientListForScopeOptions added in v0.3.0 

type RoleEligibilitySchedulesClientListForScopeOptions struct {
	// The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope.
	// Use $filter=principalId eq {id} to return all role eligibility schedules at,
	// above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility
	// schedules for the user. Use $filter=asTarget() to return all role eligibility
	// schedules created for the current user.
	Filter *string
}

RoleEligibilitySchedulesClientListForScopeOptions contains the optional parameters for the RoleEligibilitySchedulesClient.ListForScope method.

type RoleEligibilitySchedulesClientListForScopePager added in v0.3.0 

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

RoleEligibilitySchedulesClientListForScopePager provides operations for iterating over paged responses.

func (*RoleEligibilitySchedulesClientListForScopePager) Err added in v0.3.0 

func (p *RoleEligibilitySchedulesClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleEligibilitySchedulesClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleEligibilitySchedulesClientListForScopePager) 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 (*RoleEligibilitySchedulesClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleEligibilitySchedulesClientListForScopePager) PageResponse() RoleEligibilitySchedulesClientListForScopeResponse

PageResponse returns the current RoleEligibilitySchedulesClientListForScopeResponse page.

type RoleEligibilitySchedulesClientListForScopeResponse added in v0.3.0 

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

RoleEligibilitySchedulesClientListForScopeResponse contains the response from method RoleEligibilitySchedulesClient.ListForScope.

type RoleEligibilitySchedulesClientListForScopeResult added in v0.3.0 

type RoleEligibilitySchedulesClientListForScopeResult struct {
	RoleEligibilityScheduleListResult
}

RoleEligibilitySchedulesClientListForScopeResult contains the result from method RoleEligibilitySchedulesClient.ListForScope.

type RoleManagementPoliciesClient 

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

RoleManagementPoliciesClient contains the methods for the RoleManagementPolicies group. Don't use this type directly, use NewRoleManagementPoliciesClient() instead.

func NewRoleManagementPoliciesClient 

func NewRoleManagementPoliciesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleManagementPoliciesClient

NewRoleManagementPoliciesClient creates a new instance of RoleManagementPoliciesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleManagementPoliciesClient) Delete 

func (client *RoleManagementPoliciesClient) Delete(ctx context.Context, scope string, roleManagementPolicyName string, options *RoleManagementPoliciesClientDeleteOptions) (RoleManagementPoliciesClientDeleteResponse, error)

Delete - Delete a role management policy If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy to upsert. roleManagementPolicyName - The name (guid) of the role management policy to upsert. options - RoleManagementPoliciesClientDeleteOptions contains the optional parameters for the RoleManagementPoliciesClient.Delete method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/DeleteRoleManagementPolicy.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPoliciesClient(cred, nil)
	_, err = client.Delete(ctx,
		"<scope>",
		"<role-management-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleManagementPoliciesClient) Get 

func (client *RoleManagementPoliciesClient) Get(ctx context.Context, scope string, roleManagementPolicyName string, options *RoleManagementPoliciesClientGetOptions) (RoleManagementPoliciesClientGetResponse, error)

Get - Get the specified role management policy for a resource scope If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy. roleManagementPolicyName - The name (guid) of the role management policy to get. options - RoleManagementPoliciesClientGetOptions contains the optional parameters for the RoleManagementPoliciesClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPoliciesClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-management-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleManagementPoliciesClientGetResult)
}

Output:

func (*RoleManagementPoliciesClient) ListForScope 

func (client *RoleManagementPoliciesClient) ListForScope(scope string, options *RoleManagementPoliciesClientListForScopeOptions) *RoleManagementPoliciesClientListForScopePager

ListForScope - Gets role management policies for a resource scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy. options - RoleManagementPoliciesClientListForScopeOptions contains the optional parameters for the RoleManagementPoliciesClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyByScope.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPoliciesClient(cred, nil)
	pager := client.ListForScope("<scope>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RoleManagementPoliciesClient) Update 

func (client *RoleManagementPoliciesClient) Update(ctx context.Context, scope string, roleManagementPolicyName string, parameters RoleManagementPolicy, options *RoleManagementPoliciesClientUpdateOptions) (RoleManagementPoliciesClientUpdateResponse, error)

Update - Update a role management policy If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy to upsert. roleManagementPolicyName - The name (guid) of the role management policy to upsert. parameters - Parameters for the role management policy. options - RoleManagementPoliciesClientUpdateOptions contains the optional parameters for the RoleManagementPoliciesClient.Update method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/PatchPartialRoleManagementPolicy.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPoliciesClient(cred, nil)
	res, err := client.Update(ctx,
		"<scope>",
		"<role-management-policy-name>",
		armauthorization.RoleManagementPolicy{
			Properties: &armauthorization.RoleManagementPolicyProperties{
				Rules: []armauthorization.RoleManagementPolicyRuleClassification{
					&armauthorization.RoleManagementPolicyExpirationRule{
						ID:       to.StringPtr("<id>"),
						RuleType: armauthorization.RoleManagementPolicyRuleType("RoleManagementPolicyExpirationRule").ToPtr(),
						Target: &armauthorization.RoleManagementPolicyRuleTarget{
							Caller: to.StringPtr("<caller>"),
							Level:  to.StringPtr("<level>"),
							Operations: []*string{
								to.StringPtr("All")},
						},
						IsExpirationRequired: to.BoolPtr(false),
						MaximumDuration:      to.StringPtr("<maximum-duration>"),
					},
					&armauthorization.RoleManagementPolicyNotificationRule{
						ID:       to.StringPtr("<id>"),
						RuleType: armauthorization.RoleManagementPolicyRuleType("RoleManagementPolicyNotificationRule").ToPtr(),
						Target: &armauthorization.RoleManagementPolicyRuleTarget{
							Caller: to.StringPtr("<caller>"),
							Level:  to.StringPtr("<level>"),
							Operations: []*string{
								to.StringPtr("All")},
						},
						IsDefaultRecipientsEnabled: to.BoolPtr(false),
						NotificationLevel:          armauthorization.NotificationLevel("Critical").ToPtr(),
						NotificationRecipients: []*string{
							to.StringPtr("admin_admin_eligible@test.com")},
						NotificationType: armauthorization.NotificationDeliveryMechanism("Email").ToPtr(),
						RecipientType:    armauthorization.RecipientType("Admin").ToPtr(),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleManagementPoliciesClientUpdateResult)
}

Output:

type RoleManagementPoliciesClientDeleteOptions added in v0.3.0 

type RoleManagementPoliciesClientDeleteOptions struct {
}

RoleManagementPoliciesClientDeleteOptions contains the optional parameters for the RoleManagementPoliciesClient.Delete method.

type RoleManagementPoliciesClientDeleteResponse added in v0.3.0 

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

RoleManagementPoliciesClientDeleteResponse contains the response from method RoleManagementPoliciesClient.Delete.

type RoleManagementPoliciesClientGetOptions added in v0.3.0 

type RoleManagementPoliciesClientGetOptions struct {
}

RoleManagementPoliciesClientGetOptions contains the optional parameters for the RoleManagementPoliciesClient.Get method.

type RoleManagementPoliciesClientGetResponse added in v0.3.0 

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

RoleManagementPoliciesClientGetResponse contains the response from method RoleManagementPoliciesClient.Get.

type RoleManagementPoliciesClientGetResult added in v0.3.0 

type RoleManagementPoliciesClientGetResult struct {
	RoleManagementPolicy
}

RoleManagementPoliciesClientGetResult contains the result from method RoleManagementPoliciesClient.Get.

type RoleManagementPoliciesClientListForScopeOptions added in v0.3.0 

type RoleManagementPoliciesClientListForScopeOptions struct {
}

RoleManagementPoliciesClientListForScopeOptions contains the optional parameters for the RoleManagementPoliciesClient.ListForScope method.

type RoleManagementPoliciesClientListForScopePager added in v0.3.0 

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

RoleManagementPoliciesClientListForScopePager provides operations for iterating over paged responses.

func (*RoleManagementPoliciesClientListForScopePager) Err added in v0.3.0 

func (p *RoleManagementPoliciesClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleManagementPoliciesClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleManagementPoliciesClientListForScopePager) 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 (*RoleManagementPoliciesClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleManagementPoliciesClientListForScopePager) PageResponse() RoleManagementPoliciesClientListForScopeResponse

PageResponse returns the current RoleManagementPoliciesClientListForScopeResponse page.

type RoleManagementPoliciesClientListForScopeResponse added in v0.3.0 

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

RoleManagementPoliciesClientListForScopeResponse contains the response from method RoleManagementPoliciesClient.ListForScope.

type RoleManagementPoliciesClientListForScopeResult added in v0.3.0 

type RoleManagementPoliciesClientListForScopeResult struct {
	RoleManagementPolicyListResult
}

RoleManagementPoliciesClientListForScopeResult contains the result from method RoleManagementPoliciesClient.ListForScope.

type RoleManagementPoliciesClientUpdateOptions added in v0.3.0 

type RoleManagementPoliciesClientUpdateOptions struct {
}

RoleManagementPoliciesClientUpdateOptions contains the optional parameters for the RoleManagementPoliciesClient.Update method.

type RoleManagementPoliciesClientUpdateResponse added in v0.3.0 

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

RoleManagementPoliciesClientUpdateResponse contains the response from method RoleManagementPoliciesClient.Update.

type RoleManagementPoliciesClientUpdateResult added in v0.3.0 

type RoleManagementPoliciesClientUpdateResult struct {
	RoleManagementPolicy
}

RoleManagementPoliciesClientUpdateResult contains the result from method RoleManagementPoliciesClient.Update.

type RoleManagementPolicy 

type RoleManagementPolicy struct {
	// Role management policy properties.
	Properties *RoleManagementPolicyProperties `json:"properties,omitempty"`

	// READ-ONLY; The role management policy Id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role management policy name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role management policy type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleManagementPolicy - Role management policy

func (RoleManagementPolicy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicy.

type RoleManagementPolicyApprovalRule 

type RoleManagementPolicyApprovalRule struct {
	// REQUIRED; The type of rule
	RuleType *RoleManagementPolicyRuleType `json:"ruleType,omitempty"`

	// The id of the rule.
	ID *string `json:"id,omitempty"`

	// The approval setting
	Setting *ApprovalSettings `json:"setting,omitempty"`

	// The target of the current rule.
	Target *RoleManagementPolicyRuleTarget `json:"target,omitempty"`
}

RoleManagementPolicyApprovalRule - The role management policy rule.

func (*RoleManagementPolicyApprovalRule) GetRoleManagementPolicyRule added in v0.3.0 

func (r *RoleManagementPolicyApprovalRule) GetRoleManagementPolicyRule() *RoleManagementPolicyRule

GetRoleManagementPolicyRule implements the RoleManagementPolicyRuleClassification interface for type RoleManagementPolicyApprovalRule.

func (RoleManagementPolicyApprovalRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyApprovalRule.

func (*RoleManagementPolicyApprovalRule) UnmarshalJSON 

func (r *RoleManagementPolicyApprovalRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleManagementPolicyApprovalRule.

type RoleManagementPolicyAssignment 

type RoleManagementPolicyAssignment struct {
	// Role management policy properties.
	Properties *RoleManagementPolicyAssignmentProperties `json:"properties,omitempty"`

	// READ-ONLY; The role management policy Id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The role management policy name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The role management policy type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoleManagementPolicyAssignment - Role management policy

type RoleManagementPolicyAssignmentListResult 

type RoleManagementPolicyAssignmentListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role management policy assignment list.
	Value []*RoleManagementPolicyAssignment `json:"value,omitempty"`
}

RoleManagementPolicyAssignmentListResult - Role management policy assignment list operation result.

func (RoleManagementPolicyAssignmentListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyAssignmentListResult.

type RoleManagementPolicyAssignmentProperties 

type RoleManagementPolicyAssignmentProperties struct {
	// The policy id role management policy assignment.
	PolicyID *string `json:"policyId,omitempty"`

	// The role definition of management policy assignment.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`

	// The role management policy scope.
	Scope *string `json:"scope,omitempty"`

	// READ-ONLY; Additional properties of scope, role definition and policy
	PolicyAssignmentProperties *PolicyAssignmentProperties `json:"policyAssignmentProperties,omitempty" azure:"ro"`
}

RoleManagementPolicyAssignmentProperties - Role management policy assignment properties with scope.

type RoleManagementPolicyAssignmentsClient 

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

RoleManagementPolicyAssignmentsClient contains the methods for the RoleManagementPolicyAssignments group. Don't use this type directly, use NewRoleManagementPolicyAssignmentsClient() instead.

func NewRoleManagementPolicyAssignmentsClient 

func NewRoleManagementPolicyAssignmentsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *RoleManagementPolicyAssignmentsClient

NewRoleManagementPolicyAssignmentsClient creates a new instance of RoleManagementPolicyAssignmentsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoleManagementPolicyAssignmentsClient) Create 

func (client *RoleManagementPolicyAssignmentsClient) Create(ctx context.Context, scope string, roleManagementPolicyAssignmentName string, parameters RoleManagementPolicyAssignment, options *RoleManagementPolicyAssignmentsClientCreateOptions) (RoleManagementPolicyAssignmentsClientCreateResponse, error)

Create - Create a role management policy assignment If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy assignment to upsert. roleManagementPolicyAssignmentName - The name of format {guid_guid} the role management policy assignment to upsert. parameters - Parameters for the role management policy assignment. options - RoleManagementPolicyAssignmentsClientCreateOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.Create method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/PutRoleManagementPolicyAssignment.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/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPolicyAssignmentsClient(cred, nil)
	_, err = client.Create(ctx,
		"<scope>",
		"<role-management-policy-assignment-name>",
		armauthorization.RoleManagementPolicyAssignment{
			Properties: &armauthorization.RoleManagementPolicyAssignmentProperties{
				PolicyID:         to.StringPtr("<policy-id>"),
				RoleDefinitionID: to.StringPtr("<role-definition-id>"),
				Scope:            to.StringPtr("<scope>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleManagementPolicyAssignmentsClient) Delete 

func (client *RoleManagementPolicyAssignmentsClient) Delete(ctx context.Context, scope string, roleManagementPolicyAssignmentName string, options *RoleManagementPolicyAssignmentsClientDeleteOptions) (RoleManagementPolicyAssignmentsClientDeleteResponse, error)

Delete - Delete a role management policy assignment If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy assignment to delete. roleManagementPolicyAssignmentName - The name of format {guid_guid} the role management policy assignment to delete. options - RoleManagementPolicyAssignmentsClientDeleteOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.Delete method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/DeleteRoleManagementPolicyAssignment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPolicyAssignmentsClient(cred, nil)
	_, err = client.Delete(ctx,
		"<scope>",
		"<role-management-policy-assignment-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoleManagementPolicyAssignmentsClient) Get 

func (client *RoleManagementPolicyAssignmentsClient) Get(ctx context.Context, scope string, roleManagementPolicyAssignmentName string, options *RoleManagementPolicyAssignmentsClientGetOptions) (RoleManagementPolicyAssignmentsClientGetResponse, error)

Get - Get the specified role management policy assignment for a resource scope If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy. roleManagementPolicyAssignmentName - The name of format {guid_guid} the role management policy assignment to get. options - RoleManagementPolicyAssignmentsClientGetOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.Get method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPolicyAssignmentsClient(cred, nil)
	res, err := client.Get(ctx,
		"<scope>",
		"<role-management-policy-assignment-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoleManagementPolicyAssignmentsClientGetResult)
}

Output:

func (*RoleManagementPolicyAssignmentsClient) ListForScope 

func (client *RoleManagementPolicyAssignmentsClient) ListForScope(scope string, options *RoleManagementPolicyAssignmentsClientListForScopeOptions) *RoleManagementPolicyAssignmentsClientListForScopePager

ListForScope - Gets role management assignment policies for a resource scope. If the operation fails it returns an *azcore.ResponseError type. scope - The scope of the role management policy. options - RoleManagementPolicyAssignmentsClientListForScopeOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.ListForScope method.

Example

x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armauthorization.NewRoleManagementPolicyAssignmentsClient(cred, nil)
	pager := client.ListForScope("<scope>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoleManagementPolicyAssignmentsClientCreateOptions added in v0.3.0 

type RoleManagementPolicyAssignmentsClientCreateOptions struct {
}

RoleManagementPolicyAssignmentsClientCreateOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.Create method.

type RoleManagementPolicyAssignmentsClientCreateResponse added in v0.3.0 

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

RoleManagementPolicyAssignmentsClientCreateResponse contains the response from method RoleManagementPolicyAssignmentsClient.Create.

type RoleManagementPolicyAssignmentsClientCreateResult added in v0.3.0 

type RoleManagementPolicyAssignmentsClientCreateResult struct {
	RoleManagementPolicyAssignment
}

RoleManagementPolicyAssignmentsClientCreateResult contains the result from method RoleManagementPolicyAssignmentsClient.Create.

type RoleManagementPolicyAssignmentsClientDeleteOptions added in v0.3.0 

type RoleManagementPolicyAssignmentsClientDeleteOptions struct {
}

RoleManagementPolicyAssignmentsClientDeleteOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.Delete method.

type RoleManagementPolicyAssignmentsClientDeleteResponse added in v0.3.0 

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

RoleManagementPolicyAssignmentsClientDeleteResponse contains the response from method RoleManagementPolicyAssignmentsClient.Delete.

type RoleManagementPolicyAssignmentsClientGetOptions added in v0.3.0 

type RoleManagementPolicyAssignmentsClientGetOptions struct {
}

RoleManagementPolicyAssignmentsClientGetOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.Get method.

type RoleManagementPolicyAssignmentsClientGetResponse added in v0.3.0 

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

RoleManagementPolicyAssignmentsClientGetResponse contains the response from method RoleManagementPolicyAssignmentsClient.Get.

type RoleManagementPolicyAssignmentsClientGetResult added in v0.3.0 

type RoleManagementPolicyAssignmentsClientGetResult struct {
	RoleManagementPolicyAssignment
}

RoleManagementPolicyAssignmentsClientGetResult contains the result from method RoleManagementPolicyAssignmentsClient.Get.

type RoleManagementPolicyAssignmentsClientListForScopeOptions added in v0.3.0 

type RoleManagementPolicyAssignmentsClientListForScopeOptions struct {
}

RoleManagementPolicyAssignmentsClientListForScopeOptions contains the optional parameters for the RoleManagementPolicyAssignmentsClient.ListForScope method.

type RoleManagementPolicyAssignmentsClientListForScopePager added in v0.3.0 

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

RoleManagementPolicyAssignmentsClientListForScopePager provides operations for iterating over paged responses.

func (*RoleManagementPolicyAssignmentsClientListForScopePager) Err added in v0.3.0 

func (p *RoleManagementPolicyAssignmentsClientListForScopePager) Err() error

Err returns the last error encountered while paging.

func (*RoleManagementPolicyAssignmentsClientListForScopePager) NextPage added in v0.3.0 

func (p *RoleManagementPolicyAssignmentsClientListForScopePager) 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 (*RoleManagementPolicyAssignmentsClientListForScopePager) PageResponse added in v0.3.0 

func (p *RoleManagementPolicyAssignmentsClientListForScopePager) PageResponse() RoleManagementPolicyAssignmentsClientListForScopeResponse

PageResponse returns the current RoleManagementPolicyAssignmentsClientListForScopeResponse page.

type RoleManagementPolicyAssignmentsClientListForScopeResponse added in v0.3.0 

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

RoleManagementPolicyAssignmentsClientListForScopeResponse contains the response from method RoleManagementPolicyAssignmentsClient.ListForScope.

type RoleManagementPolicyAssignmentsClientListForScopeResult added in v0.3.0 

type RoleManagementPolicyAssignmentsClientListForScopeResult struct {
	RoleManagementPolicyAssignmentListResult
}

RoleManagementPolicyAssignmentsClientListForScopeResult contains the result from method RoleManagementPolicyAssignmentsClient.ListForScope.

type RoleManagementPolicyAuthenticationContextRule 

type RoleManagementPolicyAuthenticationContextRule struct {
	// REQUIRED; The type of rule
	RuleType *RoleManagementPolicyRuleType `json:"ruleType,omitempty"`

	// The claim value.
	ClaimValue *string `json:"claimValue,omitempty"`

	// The id of the rule.
	ID *string `json:"id,omitempty"`

	// The value indicating if rule is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// The target of the current rule.
	Target *RoleManagementPolicyRuleTarget `json:"target,omitempty"`
}

RoleManagementPolicyAuthenticationContextRule - The role management policy rule.

func (*RoleManagementPolicyAuthenticationContextRule) GetRoleManagementPolicyRule added in v0.3.0 

func (r *RoleManagementPolicyAuthenticationContextRule) GetRoleManagementPolicyRule() *RoleManagementPolicyRule

GetRoleManagementPolicyRule implements the RoleManagementPolicyRuleClassification interface for type RoleManagementPolicyAuthenticationContextRule.

func (RoleManagementPolicyAuthenticationContextRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyAuthenticationContextRule.

func (*RoleManagementPolicyAuthenticationContextRule) UnmarshalJSON 

func (r *RoleManagementPolicyAuthenticationContextRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleManagementPolicyAuthenticationContextRule.

type RoleManagementPolicyEnablementRule 

type RoleManagementPolicyEnablementRule struct {
	// REQUIRED; The type of rule
	RuleType *RoleManagementPolicyRuleType `json:"ruleType,omitempty"`

	// The list of enabled rules.
	EnabledRules []*EnablementRules `json:"enabledRules,omitempty"`

	// The id of the rule.
	ID *string `json:"id,omitempty"`

	// The target of the current rule.
	Target *RoleManagementPolicyRuleTarget `json:"target,omitempty"`
}

RoleManagementPolicyEnablementRule - The role management policy rule.

func (*RoleManagementPolicyEnablementRule) GetRoleManagementPolicyRule added in v0.3.0 

func (r *RoleManagementPolicyEnablementRule) GetRoleManagementPolicyRule() *RoleManagementPolicyRule

GetRoleManagementPolicyRule implements the RoleManagementPolicyRuleClassification interface for type RoleManagementPolicyEnablementRule.

func (RoleManagementPolicyEnablementRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyEnablementRule.

func (*RoleManagementPolicyEnablementRule) UnmarshalJSON 

func (r *RoleManagementPolicyEnablementRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleManagementPolicyEnablementRule.

type RoleManagementPolicyExpirationRule 

type RoleManagementPolicyExpirationRule struct {
	// REQUIRED; The type of rule
	RuleType *RoleManagementPolicyRuleType `json:"ruleType,omitempty"`

	// The id of the rule.
	ID *string `json:"id,omitempty"`

	// The value indicating whether expiration is required.
	IsExpirationRequired *bool `json:"isExpirationRequired,omitempty"`

	// The maximum duration of expiration in timespan.
	MaximumDuration *string `json:"maximumDuration,omitempty"`

	// The target of the current rule.
	Target *RoleManagementPolicyRuleTarget `json:"target,omitempty"`
}

RoleManagementPolicyExpirationRule - The role management policy rule.

func (*RoleManagementPolicyExpirationRule) GetRoleManagementPolicyRule added in v0.3.0 

func (r *RoleManagementPolicyExpirationRule) GetRoleManagementPolicyRule() *RoleManagementPolicyRule

GetRoleManagementPolicyRule implements the RoleManagementPolicyRuleClassification interface for type RoleManagementPolicyExpirationRule.

func (RoleManagementPolicyExpirationRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyExpirationRule.

func (*RoleManagementPolicyExpirationRule) UnmarshalJSON 

func (r *RoleManagementPolicyExpirationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleManagementPolicyExpirationRule.

type RoleManagementPolicyListResult 

type RoleManagementPolicyListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// Role management policy list.
	Value []*RoleManagementPolicy `json:"value,omitempty"`
}

RoleManagementPolicyListResult - Role management policy list operation result.

func (RoleManagementPolicyListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyListResult.

type RoleManagementPolicyNotificationRule 

type RoleManagementPolicyNotificationRule struct {
	// REQUIRED; The type of rule
	RuleType *RoleManagementPolicyRuleType `json:"ruleType,omitempty"`

	// The id of the rule.
	ID *string `json:"id,omitempty"`

	// Its value determine if the notification need to be sent to the recipient type specified in policy rule.
	IsDefaultRecipientsEnabled *bool `json:"isDefaultRecipientsEnabled,omitempty"`

	// The notification level.
	NotificationLevel *NotificationLevel `json:"notificationLevel,omitempty"`

	// The list notification recipients.
	NotificationRecipients []*string `json:"notificationRecipients,omitempty"`

	// The type of notification.
	NotificationType *NotificationDeliveryMechanism `json:"notificationType,omitempty"`

	// The recipient type.
	RecipientType *RecipientType `json:"recipientType,omitempty"`

	// The target of the current rule.
	Target *RoleManagementPolicyRuleTarget `json:"target,omitempty"`
}

RoleManagementPolicyNotificationRule - The role management policy rule.

func (*RoleManagementPolicyNotificationRule) GetRoleManagementPolicyRule added in v0.3.0 

func (r *RoleManagementPolicyNotificationRule) GetRoleManagementPolicyRule() *RoleManagementPolicyRule

GetRoleManagementPolicyRule implements the RoleManagementPolicyRuleClassification interface for type RoleManagementPolicyNotificationRule.

func (RoleManagementPolicyNotificationRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyNotificationRule.

func (*RoleManagementPolicyNotificationRule) UnmarshalJSON 

func (r *RoleManagementPolicyNotificationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleManagementPolicyNotificationRule.

type RoleManagementPolicyProperties 

type RoleManagementPolicyProperties struct {
	// The role management policy description.
	Description *string `json:"description,omitempty"`

	// The role management policy display name.
	DisplayName *string `json:"displayName,omitempty"`

	// The role management policy is default policy.
	IsOrganizationDefault *bool `json:"isOrganizationDefault,omitempty"`

	// The rule applied to the policy.
	Rules []RoleManagementPolicyRuleClassification `json:"rules,omitempty"`

	// The role management policy scope.
	Scope *string `json:"scope,omitempty"`

	// READ-ONLY; The readonly computed rule applied to the policy.
	EffectiveRules []RoleManagementPolicyRuleClassification `json:"effectiveRules,omitempty" azure:"ro"`

	// READ-ONLY; The name of the entity last modified it
	LastModifiedBy *Principal `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; The last modified date time.
	LastModifiedDateTime *time.Time `json:"lastModifiedDateTime,omitempty" azure:"ro"`

	// READ-ONLY; Additional properties of scope
	PolicyProperties *PolicyProperties `json:"policyProperties,omitempty" azure:"ro"`
}

RoleManagementPolicyProperties - Role management policy properties with scope.

func (RoleManagementPolicyProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyProperties.

func (*RoleManagementPolicyProperties) UnmarshalJSON 

func (r *RoleManagementPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoleManagementPolicyProperties.

type RoleManagementPolicyRule 

type RoleManagementPolicyRule struct {
	// REQUIRED; The type of rule
	RuleType *RoleManagementPolicyRuleType `json:"ruleType,omitempty"`

	// The id of the rule.
	ID *string `json:"id,omitempty"`

	// The target of the current rule.
	Target *RoleManagementPolicyRuleTarget `json:"target,omitempty"`
}

RoleManagementPolicyRule - The role management policy rule.

func (*RoleManagementPolicyRule) GetRoleManagementPolicyRule 

func (r *RoleManagementPolicyRule) GetRoleManagementPolicyRule() *RoleManagementPolicyRule

GetRoleManagementPolicyRule implements the RoleManagementPolicyRuleClassification interface for type RoleManagementPolicyRule.

type RoleManagementPolicyRuleClassification 

type RoleManagementPolicyRuleClassification interface {
	// GetRoleManagementPolicyRule returns the RoleManagementPolicyRule content of the underlying type.
	GetRoleManagementPolicyRule() *RoleManagementPolicyRule
}

RoleManagementPolicyRuleClassification provides polymorphic access to related types. Call the interface's GetRoleManagementPolicyRule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *RoleManagementPolicyApprovalRule, *RoleManagementPolicyAuthenticationContextRule, *RoleManagementPolicyEnablementRule, - *RoleManagementPolicyExpirationRule, *RoleManagementPolicyNotificationRule, *RoleManagementPolicyRule

type RoleManagementPolicyRuleTarget 

type RoleManagementPolicyRuleTarget struct {
	// The caller of the setting.
	Caller *string `json:"caller,omitempty"`

	// The list of enforced settings.
	EnforcedSettings []*string `json:"enforcedSettings,omitempty"`

	// The list of inheritable settings.
	InheritableSettings []*string `json:"inheritableSettings,omitempty"`

	// The assignment level to which it is applied.
	Level *string `json:"level,omitempty"`

	// The type of operation.
	Operations []*string `json:"operations,omitempty"`

	// The list of target objects.
	TargetObjects []*string `json:"targetObjects,omitempty"`
}

RoleManagementPolicyRuleTarget - The role management policy rule target.

func (RoleManagementPolicyRuleTarget) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoleManagementPolicyRuleTarget.

type RoleManagementPolicyRuleType 

type RoleManagementPolicyRuleType string

RoleManagementPolicyRuleType - The type of rule 

const (
	RoleManagementPolicyRuleTypeRoleManagementPolicyApprovalRule              RoleManagementPolicyRuleType = "RoleManagementPolicyApprovalRule"
	RoleManagementPolicyRuleTypeRoleManagementPolicyAuthenticationContextRule RoleManagementPolicyRuleType = "RoleManagementPolicyAuthenticationContextRule"
	RoleManagementPolicyRuleTypeRoleManagementPolicyEnablementRule            RoleManagementPolicyRuleType = "RoleManagementPolicyEnablementRule"
	RoleManagementPolicyRuleTypeRoleManagementPolicyExpirationRule            RoleManagementPolicyRuleType = "RoleManagementPolicyExpirationRule"
	RoleManagementPolicyRuleTypeRoleManagementPolicyNotificationRule          RoleManagementPolicyRuleType = "RoleManagementPolicyNotificationRule"
)

func PossibleRoleManagementPolicyRuleTypeValues 

func PossibleRoleManagementPolicyRuleTypeValues() []RoleManagementPolicyRuleType

PossibleRoleManagementPolicyRuleTypeValues returns the possible values for the RoleManagementPolicyRuleType const type.

func (RoleManagementPolicyRuleType) ToPtr 

func (c RoleManagementPolicyRuleType) ToPtr() *RoleManagementPolicyRuleType

ToPtr returns a *RoleManagementPolicyRuleType pointing to the current value.

type ServicePrincipalDecisionTarget 

type ServicePrincipalDecisionTarget struct {
	// REQUIRED; The type of decision target : User/ServicePrincipal
	Type *DecisionTargetType `json:"type,omitempty"`

	// READ-ONLY; The appId for the service principal entity being reviewed
	AppID *string `json:"appId,omitempty" azure:"ro"`

	// READ-ONLY; The id of service principal whose access is reviewed.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The display name of the service principal whose access was reviewed.
	PrincipalName *string `json:"principalName,omitempty" azure:"ro"`
}

ServicePrincipalDecisionTarget - Service Principal Decision Target

func (*ServicePrincipalDecisionTarget) GetAccessReviewDecisionTarget added in v0.3.0 

func (s *ServicePrincipalDecisionTarget) GetAccessReviewDecisionTarget() *AccessReviewDecisionTarget

GetAccessReviewDecisionTarget implements the AccessReviewDecisionTargetClassification interface for type ServicePrincipalDecisionTarget.

func (ServicePrincipalDecisionTarget) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServicePrincipalDecisionTarget.

func (*ServicePrincipalDecisionTarget) UnmarshalJSON 

func (s *ServicePrincipalDecisionTarget) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServicePrincipalDecisionTarget.

type Status 

type Status string

Status - The status of the role assignment schedule. 

const (
	StatusAccepted                    Status = "Accepted"
	StatusAdminApproved               Status = "AdminApproved"
	StatusAdminDenied                 Status = "AdminDenied"
	StatusCanceled                    Status = "Canceled"
	StatusDenied                      Status = "Denied"
	StatusFailed                      Status = "Failed"
	StatusFailedAsResourceIsLocked    Status = "FailedAsResourceIsLocked"
	StatusGranted                     Status = "Granted"
	StatusInvalid                     Status = "Invalid"
	StatusPendingAdminDecision        Status = "PendingAdminDecision"
	StatusPendingApproval             Status = "PendingApproval"
	StatusPendingApprovalProvisioning Status = "PendingApprovalProvisioning"
	StatusPendingEvaluation           Status = "PendingEvaluation"
	StatusPendingExternalProvisioning Status = "PendingExternalProvisioning"
	StatusPendingProvisioning         Status = "PendingProvisioning"
	StatusPendingRevocation           Status = "PendingRevocation"
	StatusPendingScheduleCreation     Status = "PendingScheduleCreation"
	StatusProvisioned                 Status = "Provisioned"
	StatusProvisioningStarted         Status = "ProvisioningStarted"
	StatusRevoked                     Status = "Revoked"
	StatusScheduleCreated             Status = "ScheduleCreated"
	StatusTimedOut                    Status = "TimedOut"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

func (Status) ToPtr 

func (c Status) ToPtr() *Status

ToPtr returns a *Status pointing to the current value.

type Type 

type Type string

Type - Type of the role assignment schedule expiration 

const (
	TypeAfterDateTime Type = "AfterDateTime"
	TypeAfterDuration Type = "AfterDuration"
	TypeNoExpiration  Type = "NoExpiration"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

func (Type) ToPtr 

func (c Type) ToPtr() *Type

ToPtr returns a *Type pointing to the current value.

type UserDecisionTarget 

type UserDecisionTarget struct {
	// REQUIRED; The type of decision target : User/ServicePrincipal
	Type *DecisionTargetType `json:"type,omitempty"`

	// READ-ONLY; The id of user whose access was reviewed.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The display name of the user whose access was reviewed.
	PrincipalName *string `json:"principalName,omitempty" azure:"ro"`

	// READ-ONLY; The user principal name of the user whose access was reviewed.
	UserPrincipalName *string `json:"userPrincipalName,omitempty" azure:"ro"`
}

UserDecisionTarget - User Decision Target

func (*UserDecisionTarget) GetAccessReviewDecisionTarget added in v0.3.0 

func (u *UserDecisionTarget) GetAccessReviewDecisionTarget() *AccessReviewDecisionTarget

GetAccessReviewDecisionTarget implements the AccessReviewDecisionTargetClassification interface for type UserDecisionTarget.

func (UserDecisionTarget) MarshalJSON 

func (u UserDecisionTarget) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserDecisionTarget.

func (*UserDecisionTarget) UnmarshalJSON 

func (u *UserDecisionTarget) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserDecisionTarget.

type UserSet 

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

	// The object id of the user.
	ID *string `json:"id,omitempty"`

	// The value indicating whether the user is a backup fallback approver
	IsBackup *bool `json:"isBackup,omitempty"`

	// The type of user.
	UserType *UserType `json:"userType,omitempty"`
}

UserSet - The detail of a user.

type UserType 

type UserType string

UserType - The type of user. 

const (
	UserTypeGroup UserType = "Group"
	UserTypeUser  UserType = "User"
)

func PossibleUserTypeValues 

func PossibleUserTypeValues() []UserType

PossibleUserTypeValues returns the possible values for the UserType const type.

func (UserType) ToPtr 

func (c UserType) ToPtr() *UserType

ToPtr returns a *UserType pointing to the current value.

type ValidationResponse 

type ValidationResponse struct {
	// Failed validation result details
	ErrorInfo *ValidationResponseErrorInfo `json:"errorInfo,omitempty"`

	// READ-ONLY; Whether or not validation succeeded
	IsValid *bool `json:"isValid,omitempty" azure:"ro"`
}

ValidationResponse - Validation response

type ValidationResponseErrorInfo 

type ValidationResponseErrorInfo struct {
	// READ-ONLY; Error code indicating why validation failed
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Message indicating why validation failed
	Message *string `json:"message,omitempty" azure:"ro"`
}

ValidationResponseErrorInfo - Failed validation result details

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.