aad

package
v68.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2023 License: MIT Imports: 9 Imported by: 56

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/aad/armaad(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/aad/armaad). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package aad implements the Azure ARM Aad service API version .

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Aad
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type ARMProxyResource 

type ARMProxyResource struct {
	// ID - READ-ONLY; The unique resource identifier of the Azure AD PrivateLink Policy.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the Azure AD PrivateLink Policy.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

ARMProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

func (ARMProxyResource) MarshalJSON 

func (apr ARMProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ARMProxyResource.

type AzureADMetricsClient 

type AzureADMetricsClient struct {
	BaseClient
}

AzureADMetricsClient is the client for the AzureADMetrics methods of the Aad service.

func NewAzureADMetricsClient 

func NewAzureADMetricsClient(subscriptionID string) AzureADMetricsClient

NewAzureADMetricsClient creates an instance of the AzureADMetricsClient client.

func NewAzureADMetricsClientWithBaseURI 

func NewAzureADMetricsClientWithBaseURI(baseURI string, subscriptionID string) AzureADMetricsClient

NewAzureADMetricsClientWithBaseURI creates an instance of the AzureADMetricsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AzureADMetricsClient) CreateOrUpdate 

func (client AzureADMetricsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, azureADMetricsName string, azureADMetricsConfig AzureADMetricsConfig) (result AzureADMetricsCreateOrUpdateFuture, err error)

CreateOrUpdate creates a azureADMetrics instance. Parameters: resourceGroupName - name of an Azure resource group. azureADMetricsName - name of the azureADMetrics instance. azureADMetricsConfig - azureADMetrics definition supplied to the operation.

func (AzureADMetricsClient) CreateOrUpdatePreparer 

func (client AzureADMetricsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, azureADMetricsName string, azureADMetricsConfig AzureADMetricsConfig) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AzureADMetricsClient) CreateOrUpdateResponder 

func (client AzureADMetricsClient) CreateOrUpdateResponder(resp *http.Response) (result AzureADMetricsConfig, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AzureADMetricsClient) CreateOrUpdateSender 

func (client AzureADMetricsClient) CreateOrUpdateSender(req *http.Request) (future AzureADMetricsCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (AzureADMetricsClient) Delete 

func (client AzureADMetricsClient) Delete(ctx context.Context, resourceGroupName string, azureADMetricsName string) (result autorest.Response, err error)

Delete deletes a AzureADMetrics resource. When operation completes, status code 200 returned without content. Parameters: resourceGroupName - name of an Azure resource group. azureADMetricsName - name of the azureADMetrics instance.

func (AzureADMetricsClient) DeletePreparer 

func (client AzureADMetricsClient) DeletePreparer(ctx context.Context, resourceGroupName string, azureADMetricsName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AzureADMetricsClient) DeleteResponder 

func (client AzureADMetricsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AzureADMetricsClient) DeleteSender 

func (client AzureADMetricsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (AzureADMetricsClient) Get 

func (client AzureADMetricsClient) Get(ctx context.Context, resourceGroupName string, azureADMetricsName string) (result AzureADMetricsConfig, err error)

Get gets a azureADMetrics instance with a given name. Parameters: resourceGroupName - name of an Azure resource group. azureADMetricsName - name of the azureADMetrics instance.

func (AzureADMetricsClient) GetPreparer 

func (client AzureADMetricsClient) GetPreparer(ctx context.Context, resourceGroupName string, azureADMetricsName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AzureADMetricsClient) GetResponder 

func (client AzureADMetricsClient) GetResponder(resp *http.Response) (result AzureADMetricsConfig, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AzureADMetricsClient) GetSender 

func (client AzureADMetricsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AzureADMetricsClient) List 

func (client AzureADMetricsClient) List(ctx context.Context, resourceGroupName string) (result AzureADMetricsListResultPage, err error)

List operation to return the list of AzureADMetrics resources scoped to the resourceGroup. Parameters: resourceGroupName - name of an Azure resource group.

func (AzureADMetricsClient) ListBySubscription 

func (client AzureADMetricsClient) ListBySubscription(ctx context.Context) (result AzureADMetricsListResultPage, err error)

ListBySubscription lists all AzureADMetrics resources in the given subscription.

func (AzureADMetricsClient) ListBySubscriptionComplete 

func (client AzureADMetricsClient) ListBySubscriptionComplete(ctx context.Context) (result AzureADMetricsListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (AzureADMetricsClient) ListBySubscriptionPreparer 

func (client AzureADMetricsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AzureADMetricsClient) ListBySubscriptionResponder 

func (client AzureADMetricsClient) ListBySubscriptionResponder(resp *http.Response) (result AzureADMetricsListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (AzureADMetricsClient) ListBySubscriptionSender 

func (client AzureADMetricsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (AzureADMetricsClient) ListComplete 

func (client AzureADMetricsClient) ListComplete(ctx context.Context, resourceGroupName string) (result AzureADMetricsListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (AzureADMetricsClient) ListPreparer 

func (client AzureADMetricsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (AzureADMetricsClient) ListResponder 

func (client AzureADMetricsClient) ListResponder(resp *http.Response) (result AzureADMetricsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AzureADMetricsClient) ListSender 

func (client AzureADMetricsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (AzureADMetricsClient) Update 

func (client AzureADMetricsClient) Update(ctx context.Context, resourceGroupName string, azureADMetricsName string, azureADMetricsConfig *AzureADMetricsUpdateParameter) (result AzureADMetricsConfig, err error)

Update updates azureADMetrics tags with specified values. Parameters: resourceGroupName - name of an Azure resource group. azureADMetricsName - name of the azureADMetrics instance. azureADMetricsConfig - azureADMetrics resource with the tags to be updated.

func (AzureADMetricsClient) UpdatePreparer 

func (client AzureADMetricsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, azureADMetricsName string, azureADMetricsConfig *AzureADMetricsUpdateParameter) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AzureADMetricsClient) UpdateResponder 

func (client AzureADMetricsClient) UpdateResponder(resp *http.Response) (result AzureADMetricsConfig, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (AzureADMetricsClient) UpdateSender 

func (client AzureADMetricsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type AzureADMetricsConfig 

type AzureADMetricsConfig struct {
	autorest.Response `json:"-"`
	Properties        *AzureADMetricsPropertiesFormat `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureADMetricsConfig azureADMetrics resource.

func (AzureADMetricsConfig) MarshalJSON 

func (amc AzureADMetricsConfig) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureADMetricsConfig.

type AzureADMetricsCreateOrUpdateFuture 

type AzureADMetricsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AzureADMetricsClient) (AzureADMetricsConfig, error)
}

AzureADMetricsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*AzureADMetricsCreateOrUpdateFuture) UnmarshalJSON 

func (future *AzureADMetricsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AzureADMetricsListResult 

type AzureADMetricsListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; Array of AzureADMetrics resources.
	Value *[]AzureADMetricsConfig `json:"value,omitempty"`
	// NextLink - READ-ONLY; The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

AzureADMetricsListResult a list of AzureADMetrics resources

func (AzureADMetricsListResult) IsEmpty 

func (amlr AzureADMetricsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (AzureADMetricsListResult) MarshalJSON 

func (amlr AzureADMetricsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureADMetricsListResult.

type AzureADMetricsListResultIterator 

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

AzureADMetricsListResultIterator provides access to a complete listing of AzureADMetricsConfig values.

func NewAzureADMetricsListResultIterator 

func NewAzureADMetricsListResultIterator(page AzureADMetricsListResultPage) AzureADMetricsListResultIterator

Creates a new instance of the AzureADMetricsListResultIterator type.

func (*AzureADMetricsListResultIterator) Next 

func (iter *AzureADMetricsListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AzureADMetricsListResultIterator) NextWithContext 

func (iter *AzureADMetricsListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AzureADMetricsListResultIterator) NotDone 

func (iter AzureADMetricsListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AzureADMetricsListResultIterator) Response 

func (iter AzureADMetricsListResultIterator) Response() AzureADMetricsListResult

Response returns the raw server response from the last page request.

func (AzureADMetricsListResultIterator) Value 

func (iter AzureADMetricsListResultIterator) Value() AzureADMetricsConfig

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AzureADMetricsListResultPage 

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

AzureADMetricsListResultPage contains a page of AzureADMetricsConfig values.

func NewAzureADMetricsListResultPage 

func NewAzureADMetricsListResultPage(cur AzureADMetricsListResult, getNextPage func(context.Context, AzureADMetricsListResult) (AzureADMetricsListResult, error)) AzureADMetricsListResultPage

Creates a new instance of the AzureADMetricsListResultPage type.

func (*AzureADMetricsListResultPage) Next 

func (page *AzureADMetricsListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AzureADMetricsListResultPage) NextWithContext 

func (page *AzureADMetricsListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AzureADMetricsListResultPage) NotDone 

func (page AzureADMetricsListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AzureADMetricsListResultPage) Response 

func (page AzureADMetricsListResultPage) Response() AzureADMetricsListResult

Response returns the raw server response from the last page request.

func (AzureADMetricsListResultPage) Values 

func (page AzureADMetricsListResultPage) Values() []AzureADMetricsConfig

Values returns the slice of values for the current page or nil if there are no values.

type AzureADMetricsPropertiesFormat 

type AzureADMetricsPropertiesFormat struct {
	// ProvisioningState - READ-ONLY; The provisioning state of the resource. Possible values include: 'ProvisioningStateSucceeded', 'ProvisioningStateCreated', 'ProvisioningStateFailed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

AzureADMetricsPropertiesFormat ...

func (AzureADMetricsPropertiesFormat) MarshalJSON 

func (aampf AzureADMetricsPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureADMetricsPropertiesFormat.

type AzureADMetricsUpdateParameter 

type AzureADMetricsUpdateParameter struct {
	// Tags - Resource tags to be updated.
	Tags map[string]*string `json:"tags"`
}

AzureADMetricsUpdateParameter azureADMetrics parameters to be updated.

func (AzureADMetricsUpdateParameter) MarshalJSON 

func (amup AzureADMetricsUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureADMetricsUpdateParameter.

type AzureEntityResource 

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON 

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type AzureResourceBase 

type AzureResourceBase struct {
	// ID - READ-ONLY; String Id used to locate any resource on Azure.
	ID *string `json:"id,omitempty"`
	// Name - Name of this resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Type of this resource.
	Type *string `json:"type,omitempty"`
}

AzureResourceBase common properties for all Azure resources.

func (AzureResourceBase) MarshalJSON 

func (arb AzureResourceBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureResourceBase.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Aad.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type ErrorDefinition 

type ErrorDefinition struct {
	// Code - READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Description of the error.
	Message *string `json:"message,omitempty"`
	// Details - READ-ONLY; Internal error details.
	Details *[]ErrorDefinition `json:"details,omitempty"`
}

ErrorDefinition error definition.

func (ErrorDefinition) MarshalJSON 

func (ed ErrorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDefinition.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The error details.
	Error *ErrorDefinition `json:"error,omitempty"`
}

ErrorResponse error response.

type PrivateLinkForAzureAdClient 

type PrivateLinkForAzureAdClient struct {
	BaseClient
}

PrivateLinkForAzureAdClient is the client for the PrivateLinkForAzureAd methods of the Aad service.

func NewPrivateLinkForAzureAdClient 

func NewPrivateLinkForAzureAdClient(subscriptionID string) PrivateLinkForAzureAdClient

NewPrivateLinkForAzureAdClient creates an instance of the PrivateLinkForAzureAdClient client.

func NewPrivateLinkForAzureAdClientWithBaseURI 

func NewPrivateLinkForAzureAdClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkForAzureAdClient

NewPrivateLinkForAzureAdClientWithBaseURI creates an instance of the PrivateLinkForAzureAdClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PrivateLinkForAzureAdClient) Create 

func (client PrivateLinkForAzureAdClient) Create(ctx context.Context, resourceGroupName string, policyName string, privateLinkPolicy PrivateLinkPolicy) (result PrivateLinkForAzureAdCreateFuture, err error)

Create creates a private link policy. Parameters: resourceGroupName - name of an Azure resource group. policyName - the name of the private link policy in Azure AD. privateLinkPolicy - private link Policy supplied to the operation.

func (PrivateLinkForAzureAdClient) CreatePreparer 

func (client PrivateLinkForAzureAdClient) CreatePreparer(ctx context.Context, resourceGroupName string, policyName string, privateLinkPolicy PrivateLinkPolicy) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PrivateLinkForAzureAdClient) CreateResponder 

func (client PrivateLinkForAzureAdClient) CreateResponder(resp *http.Response) (result PrivateLinkPolicy, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (PrivateLinkForAzureAdClient) CreateSender 

func (client PrivateLinkForAzureAdClient) CreateSender(req *http.Request) (future PrivateLinkForAzureAdCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (PrivateLinkForAzureAdClient) Delete 

func (client PrivateLinkForAzureAdClient) Delete(ctx context.Context, resourceGroupName string, policyName string) (result autorest.Response, err error)

Delete deletes a private link policy. When operation completes, status code 200 returned without content. Parameters: resourceGroupName - name of an Azure resource group. policyName - the name of the private link policy in Azure AD.

func (PrivateLinkForAzureAdClient) DeletePreparer 

func (client PrivateLinkForAzureAdClient) DeletePreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PrivateLinkForAzureAdClient) DeleteResponder 

func (client PrivateLinkForAzureAdClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PrivateLinkForAzureAdClient) DeleteSender 

func (client PrivateLinkForAzureAdClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PrivateLinkForAzureAdClient) Get 

func (client PrivateLinkForAzureAdClient) Get(ctx context.Context, resourceGroupName string, policyName string) (result PrivateLinkPolicy, err error)

Get gets a private link policy with a given name. Parameters: resourceGroupName - name of an Azure resource group. policyName - the name of the private link policy in Azure AD.

func (PrivateLinkForAzureAdClient) GetPreparer 

func (client PrivateLinkForAzureAdClient) GetPreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PrivateLinkForAzureAdClient) GetResponder 

func (client PrivateLinkForAzureAdClient) GetResponder(resp *http.Response) (result PrivateLinkPolicy, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PrivateLinkForAzureAdClient) GetSender 

func (client PrivateLinkForAzureAdClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PrivateLinkForAzureAdClient) List 

func (client PrivateLinkForAzureAdClient) List(ctx context.Context, resourceGroupName string) (result PrivateLinkPolicyListResultPage, err error)

List operation to return the list of Private Link Policies For AzureAD scoped to the resourceGroup. Parameters: resourceGroupName - name of an Azure resource group.

func (PrivateLinkForAzureAdClient) ListBySubscription 

func (client PrivateLinkForAzureAdClient) ListBySubscription(ctx context.Context) (result PrivateLinkPolicyListResultPage, err error)

ListBySubscription lists all Private Link Policies For AzureAD in the given subscription.

func (PrivateLinkForAzureAdClient) ListBySubscriptionComplete 

func (client PrivateLinkForAzureAdClient) ListBySubscriptionComplete(ctx context.Context) (result PrivateLinkPolicyListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (PrivateLinkForAzureAdClient) ListBySubscriptionPreparer 

func (client PrivateLinkForAzureAdClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (PrivateLinkForAzureAdClient) ListBySubscriptionResponder 

func (client PrivateLinkForAzureAdClient) ListBySubscriptionResponder(resp *http.Response) (result PrivateLinkPolicyListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (PrivateLinkForAzureAdClient) ListBySubscriptionSender 

func (client PrivateLinkForAzureAdClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (PrivateLinkForAzureAdClient) ListComplete 

func (client PrivateLinkForAzureAdClient) ListComplete(ctx context.Context, resourceGroupName string) (result PrivateLinkPolicyListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (PrivateLinkForAzureAdClient) ListPreparer 

func (client PrivateLinkForAzureAdClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PrivateLinkForAzureAdClient) ListResponder 

func (client PrivateLinkForAzureAdClient) ListResponder(resp *http.Response) (result PrivateLinkPolicyListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PrivateLinkForAzureAdClient) ListSender 

func (client PrivateLinkForAzureAdClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (PrivateLinkForAzureAdClient) Update 

func (client PrivateLinkForAzureAdClient) Update(ctx context.Context, resourceGroupName string, policyName string, privateLinkPolicy *PrivateLinkPolicyUpdateParameter) (result PrivateLinkPolicy, err error)

Update updates private link policy tags with specified values. Parameters: resourceGroupName - name of an Azure resource group. policyName - the name of the private link policy in Azure AD. privateLinkPolicy - private Link Policy resource with the tags to be updated.

func (PrivateLinkForAzureAdClient) UpdatePreparer 

func (client PrivateLinkForAzureAdClient) UpdatePreparer(ctx context.Context, resourceGroupName string, policyName string, privateLinkPolicy *PrivateLinkPolicyUpdateParameter) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PrivateLinkForAzureAdClient) UpdateResponder 

func (client PrivateLinkForAzureAdClient) UpdateResponder(resp *http.Response) (result PrivateLinkPolicy, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (PrivateLinkForAzureAdClient) UpdateSender 

func (client PrivateLinkForAzureAdClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type PrivateLinkForAzureAdCreateFuture 

type PrivateLinkForAzureAdCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(PrivateLinkForAzureAdClient) (PrivateLinkPolicy, error)
}

PrivateLinkForAzureAdCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PrivateLinkForAzureAdCreateFuture) UnmarshalJSON 

func (future *PrivateLinkForAzureAdCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateLinkPolicy 

type PrivateLinkPolicy struct {
	autorest.Response `json:"-"`
	// OwnerTenantID - Guid of the owner tenant
	OwnerTenantID *string `json:"ownerTenantId,omitempty"`
	// AllTenants - Flag indicating whether all tenants are allowed
	AllTenants *bool `json:"allTenants,omitempty"`
	// Tenants - The list of tenantIds.
	Tenants *[]string `json:"tenants,omitempty"`
	// ResourceName - Name of the private link policy resource
	ResourceName *string `json:"resourceName,omitempty"`
	// SubscriptionID - Subscription Identifier
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// ResourceGroup - Name of the resource group
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; String Id used to locate any resource on Azure.
	ID *string `json:"id,omitempty"`
	// Name - Name of this resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Type of this resource.
	Type *string `json:"type,omitempty"`
}

PrivateLinkPolicy privateLink Policy configuration object.

func (PrivateLinkPolicy) MarshalJSON 

func (plp PrivateLinkPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkPolicy.

type PrivateLinkPolicyListResult 

type PrivateLinkPolicyListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private link policies
	Value *[]PrivateLinkPolicy `json:"value,omitempty"`
	// NextLink - The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

PrivateLinkPolicyListResult a list of private link policies

func (PrivateLinkPolicyListResult) IsEmpty 

func (plplr PrivateLinkPolicyListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateLinkPolicyListResultIterator 

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

PrivateLinkPolicyListResultIterator provides access to a complete listing of PrivateLinkPolicy values.

func NewPrivateLinkPolicyListResultIterator 

func NewPrivateLinkPolicyListResultIterator(page PrivateLinkPolicyListResultPage) PrivateLinkPolicyListResultIterator

Creates a new instance of the PrivateLinkPolicyListResultIterator type.

func (*PrivateLinkPolicyListResultIterator) Next 

func (iter *PrivateLinkPolicyListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkPolicyListResultIterator) NextWithContext 

func (iter *PrivateLinkPolicyListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PrivateLinkPolicyListResultIterator) NotDone 

func (iter PrivateLinkPolicyListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PrivateLinkPolicyListResultIterator) Response 

func (iter PrivateLinkPolicyListResultIterator) Response() PrivateLinkPolicyListResult

Response returns the raw server response from the last page request.

func (PrivateLinkPolicyListResultIterator) Value 

func (iter PrivateLinkPolicyListResultIterator) Value() PrivateLinkPolicy

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PrivateLinkPolicyListResultPage 

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

PrivateLinkPolicyListResultPage contains a page of PrivateLinkPolicy values.

func NewPrivateLinkPolicyListResultPage 

func NewPrivateLinkPolicyListResultPage(cur PrivateLinkPolicyListResult, getNextPage func(context.Context, PrivateLinkPolicyListResult) (PrivateLinkPolicyListResult, error)) PrivateLinkPolicyListResultPage

Creates a new instance of the PrivateLinkPolicyListResultPage type.

func (*PrivateLinkPolicyListResultPage) Next 

func (page *PrivateLinkPolicyListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkPolicyListResultPage) NextWithContext 

func (page *PrivateLinkPolicyListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PrivateLinkPolicyListResultPage) NotDone 

func (page PrivateLinkPolicyListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PrivateLinkPolicyListResultPage) Response 

func (page PrivateLinkPolicyListResultPage) Response() PrivateLinkPolicyListResult

Response returns the raw server response from the last page request.

func (PrivateLinkPolicyListResultPage) Values 

func (page PrivateLinkPolicyListResultPage) Values() []PrivateLinkPolicy

Values returns the slice of values for the current page or nil if there are no values.

type PrivateLinkPolicyUpdateParameter 

type PrivateLinkPolicyUpdateParameter struct {
	// Tags - Resource tags to be updated.
	Tags map[string]*string `json:"tags"`
}

PrivateLinkPolicyUpdateParameter private Link policy parameters to be updated.

func (PrivateLinkPolicyUpdateParameter) MarshalJSON 

func (plpup PrivateLinkPolicyUpdateParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkPolicyUpdateParameter.

type PrivateLinkResource 

type PrivateLinkResource struct {
	autorest.Response `json:"-"`
	// PrivateLinkResourceProperties - Resource properties.
	*PrivateLinkResourceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the Azure AD PrivateLink Policy.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the Azure AD PrivateLink Policy.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

PrivateLinkResource a private link resource

func (PrivateLinkResource) MarshalJSON 

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private link resources
	Value *[]PrivateLinkResource `json:"value,omitempty"`
	// NextLink - The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

PrivateLinkResourceListResult a list of private link resources

func (PrivateLinkResourceListResult) IsEmpty 

func (plrlr PrivateLinkResourceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateLinkResourceListResultIterator 

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

PrivateLinkResourceListResultIterator provides access to a complete listing of PrivateLinkResource values.

func NewPrivateLinkResourceListResultIterator 

func NewPrivateLinkResourceListResultIterator(page PrivateLinkResourceListResultPage) PrivateLinkResourceListResultIterator

Creates a new instance of the PrivateLinkResourceListResultIterator type.

func (*PrivateLinkResourceListResultIterator) Next 

func (iter *PrivateLinkResourceListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkResourceListResultIterator) NextWithContext 

func (iter *PrivateLinkResourceListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PrivateLinkResourceListResultIterator) NotDone 

func (iter PrivateLinkResourceListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PrivateLinkResourceListResultIterator) Response 

func (iter PrivateLinkResourceListResultIterator) Response() PrivateLinkResourceListResult

Response returns the raw server response from the last page request.

func (PrivateLinkResourceListResultIterator) Value 

func (iter PrivateLinkResourceListResultIterator) Value() PrivateLinkResource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PrivateLinkResourceListResultPage 

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

PrivateLinkResourceListResultPage contains a page of PrivateLinkResource values.

func NewPrivateLinkResourceListResultPage 

func NewPrivateLinkResourceListResultPage(cur PrivateLinkResourceListResult, getNextPage func(context.Context, PrivateLinkResourceListResult) (PrivateLinkResourceListResult, error)) PrivateLinkResourceListResultPage

Creates a new instance of the PrivateLinkResourceListResultPage type.

func (*PrivateLinkResourceListResultPage) Next 

func (page *PrivateLinkResourceListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkResourceListResultPage) NextWithContext 

func (page *PrivateLinkResourceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PrivateLinkResourceListResultPage) NotDone 

func (page PrivateLinkResourceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PrivateLinkResourceListResultPage) Response 

func (page PrivateLinkResourceListResultPage) Response() PrivateLinkResourceListResult

Response returns the raw server response from the last page request.

func (PrivateLinkResourceListResultPage) Values 

func (page PrivateLinkResourceListResultPage) Values() []PrivateLinkResource

Values returns the slice of values for the current page or nil if there are no values.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// GroupID - READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - READ-ONLY; The private link resource required member names.
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
}

PrivateLinkResourceProperties properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	BaseClient
}

PrivateLinkResourcesClient is the client for the PrivateLinkResources methods of the Aad service.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI 

func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PrivateLinkResourcesClient) Get 

func (client PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, policyName string, groupName string) (result PrivateLinkResource, err error)

Get gets the private link resources that need to be created for a policy of AzureAD. Parameters: resourceGroupName - name of an Azure resource group. policyName - the name of the private link policy in Azure AD. groupName - the name of the private link resource.

func (PrivateLinkResourcesClient) GetPreparer 

func (client PrivateLinkResourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, policyName string, groupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PrivateLinkResourcesClient) GetResponder 

func (client PrivateLinkResourcesClient) GetResponder(resp *http.Response) (result PrivateLinkResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) GetSender 

func (client PrivateLinkResourcesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicy 

func (client PrivateLinkResourcesClient) ListByPrivateLinkPolicy(ctx context.Context, resourceGroupName string, policyName string) (result PrivateLinkResourceListResultPage, err error)

ListByPrivateLinkPolicy gets the private link resources that need to be created for a policy of AzureAD. Parameters: resourceGroupName - name of an Azure resource group. policyName - the name of the private link policy in Azure AD.

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicyComplete 

func (client PrivateLinkResourcesClient) ListByPrivateLinkPolicyComplete(ctx context.Context, resourceGroupName string, policyName string) (result PrivateLinkResourceListResultIterator, err error)

ListByPrivateLinkPolicyComplete enumerates all values, automatically crossing page boundaries as required.

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicyPreparer 

func (client PrivateLinkResourcesClient) ListByPrivateLinkPolicyPreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)

ListByPrivateLinkPolicyPreparer prepares the ListByPrivateLinkPolicy request.

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicyResponder 

func (client PrivateLinkResourcesClient) ListByPrivateLinkPolicyResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)

ListByPrivateLinkPolicyResponder handles the response to the ListByPrivateLinkPolicy request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) ListByPrivateLinkPolicySender 

func (client PrivateLinkResourcesClient) ListByPrivateLinkPolicySender(req *http.Request) (*http.Response, error)

ListByPrivateLinkPolicySender sends the ListByPrivateLinkPolicy request. The method will close the http.Response Body if it receives an error.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateCreated ...
	ProvisioningStateCreated ProvisioningState = "Created"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

Source Files

View all Source files

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
 Deprecated: Please note, this package has been deprecated.

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.