serviceprincipal

package
v0.20241203.1090052 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/microsoft-graph/serviceprincipals/stable/serviceprincipal Documentation

The serviceprincipal SDK allows for interaction with Microsoft Graph serviceprincipals (API Version stable).

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

Import Path

import "github.com/hashicorp/go-azure-sdk/microsoft-graph/serviceprincipals/stable/serviceprincipal"

Client Initialization

client := serviceprincipal.NewServicePrincipalClientWithBaseURI("https://graph.microsoft.com")
client.Client.Authorizer = authorizer

Example Usage: ServicePrincipalClient.AddKey

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.AddKeyRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.AddPassword

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.AddPasswordRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.AddTokenSigningCertificate

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.AddTokenSigningCertificateRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.CheckMemberGroups

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.CheckMemberGroupsRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.CheckMemberObjects

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.CheckMemberObjectsRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.CreateServicePrincipal

ctx := context.TODO()

payload := serviceprincipal.ServicePrincipal{
	// ...
}


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

Example Usage: ServicePrincipalClient.CreateValidatesProperty

ctx := context.TODO()

payload := serviceprincipal.CreateValidatesPropertyRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.DeleteServicePrincipal

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

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

Example Usage: ServicePrincipalClient.GetMemberGroups

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.GetMemberGroupsRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.GetMemberObjects

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.GetMemberObjectsRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.GetServicePrincipal

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

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

Example Usage: ServicePrincipalClient.GetsCount

ctx := context.TODO()


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

Example Usage: ServicePrincipalClient.ListGetsAvailableExtensionProperties

ctx := context.TODO()

payload := serviceprincipal.ListGetsAvailableExtensionPropertiesRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.ListGetsByIds

ctx := context.TODO()

payload := serviceprincipal.ListGetsByIdsRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.ListServicePrincipals

ctx := context.TODO()


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

Example Usage: ServicePrincipalClient.RemoveKey

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.RemoveKeyRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.RemovePassword

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.RemovePasswordRequest{
	// ...
}


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

Example Usage: ServicePrincipalClient.Restore

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

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

Example Usage: ServicePrincipalClient.UpdateServicePrincipal

ctx := context.TODO()
id := serviceprincipal.NewServicePrincipalID("servicePrincipalId")

payload := serviceprincipal.ServicePrincipal{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddKeyOperationOptions 

type AddKeyOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultAddKeyOperationOptions 

func DefaultAddKeyOperationOptions() AddKeyOperationOptions

func (AddKeyOperationOptions) ToHeaders 

func (o AddKeyOperationOptions) ToHeaders() *client.Headers

func (AddKeyOperationOptions) ToOData 

func (o AddKeyOperationOptions) ToOData() *odata.Query

func (AddKeyOperationOptions) ToQuery 

func (o AddKeyOperationOptions) ToQuery() *client.QueryParams

type AddKeyOperationResponse 

type AddKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.KeyCredential
}

type AddKeyRequest 

type AddKeyRequest struct {
	KeyCredential      *stable.KeyCredential      `json:"keyCredential,omitempty"`
	PasswordCredential *stable.PasswordCredential `json:"passwordCredential,omitempty"`
	Proof              *string                    `json:"proof,omitempty"`
}

type AddPasswordOperationOptions 

type AddPasswordOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultAddPasswordOperationOptions 

func DefaultAddPasswordOperationOptions() AddPasswordOperationOptions

func (AddPasswordOperationOptions) ToHeaders 

func (o AddPasswordOperationOptions) ToHeaders() *client.Headers

func (AddPasswordOperationOptions) ToOData 

func (o AddPasswordOperationOptions) ToOData() *odata.Query

func (AddPasswordOperationOptions) ToQuery 

func (o AddPasswordOperationOptions) ToQuery() *client.QueryParams

type AddPasswordOperationResponse 

type AddPasswordOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.PasswordCredential
}

type AddPasswordRequest 

type AddPasswordRequest struct {
	PasswordCredential *stable.PasswordCredential `json:"passwordCredential,omitempty"`
}

type AddTokenSigningCertificateOperationOptions 

type AddTokenSigningCertificateOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultAddTokenSigningCertificateOperationOptions 

func DefaultAddTokenSigningCertificateOperationOptions() AddTokenSigningCertificateOperationOptions

func (AddTokenSigningCertificateOperationOptions) ToHeaders 

func (o AddTokenSigningCertificateOperationOptions) ToHeaders() *client.Headers

func (AddTokenSigningCertificateOperationOptions) ToOData 

func (o AddTokenSigningCertificateOperationOptions) ToOData() *odata.Query

func (AddTokenSigningCertificateOperationOptions) ToQuery 

func (o AddTokenSigningCertificateOperationOptions) ToQuery() *client.QueryParams

type AddTokenSigningCertificateOperationResponse 

type AddTokenSigningCertificateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.SelfSignedCertificate
}

type AddTokenSigningCertificateRequest 

type AddTokenSigningCertificateRequest struct {
	DisplayName nullable.Type[string] `json:"displayName,omitempty"`
	EndDateTime nullable.Type[string] `json:"endDateTime,omitempty"`
}

type CheckMemberGroupsCompleteResult 

type CheckMemberGroupsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type CheckMemberGroupsCustomPager 

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

type CheckMemberGroupsOperationOptions 

type CheckMemberGroupsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultCheckMemberGroupsOperationOptions 

func DefaultCheckMemberGroupsOperationOptions() CheckMemberGroupsOperationOptions

func (CheckMemberGroupsOperationOptions) ToHeaders 

func (o CheckMemberGroupsOperationOptions) ToHeaders() *client.Headers

func (CheckMemberGroupsOperationOptions) ToOData 

func (o CheckMemberGroupsOperationOptions) ToOData() *odata.Query

func (CheckMemberGroupsOperationOptions) ToQuery 

func (o CheckMemberGroupsOperationOptions) ToQuery() *client.QueryParams

type CheckMemberGroupsOperationResponse 

type CheckMemberGroupsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type CheckMemberGroupsRequest 

type CheckMemberGroupsRequest struct {
	GroupIds *[]string `json:"groupIds,omitempty"`
}

type CheckMemberObjectsCompleteResult 

type CheckMemberObjectsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type CheckMemberObjectsCustomPager 

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

type CheckMemberObjectsOperationOptions 

type CheckMemberObjectsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultCheckMemberObjectsOperationOptions 

func DefaultCheckMemberObjectsOperationOptions() CheckMemberObjectsOperationOptions

func (CheckMemberObjectsOperationOptions) ToHeaders 

func (o CheckMemberObjectsOperationOptions) ToHeaders() *client.Headers

func (CheckMemberObjectsOperationOptions) ToOData 

func (o CheckMemberObjectsOperationOptions) ToOData() *odata.Query

func (CheckMemberObjectsOperationOptions) ToQuery 

func (o CheckMemberObjectsOperationOptions) ToQuery() *client.QueryParams

type CheckMemberObjectsOperationResponse 

type CheckMemberObjectsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type CheckMemberObjectsRequest 

type CheckMemberObjectsRequest struct {
	Ids *[]string `json:"ids,omitempty"`
}

type CreateServicePrincipalOperationOptions 

type CreateServicePrincipalOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreateServicePrincipalOperationOptions 

func DefaultCreateServicePrincipalOperationOptions() CreateServicePrincipalOperationOptions

func (CreateServicePrincipalOperationOptions) ToHeaders 

func (o CreateServicePrincipalOperationOptions) ToHeaders() *client.Headers

func (CreateServicePrincipalOperationOptions) ToOData 

func (o CreateServicePrincipalOperationOptions) ToOData() *odata.Query

func (CreateServicePrincipalOperationOptions) ToQuery 

func (o CreateServicePrincipalOperationOptions) ToQuery() *client.QueryParams

type CreateServicePrincipalOperationResponse 

type CreateServicePrincipalOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.ServicePrincipal
}

type CreateValidatesPropertyOperationOptions 

type CreateValidatesPropertyOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultCreateValidatesPropertyOperationOptions 

func DefaultCreateValidatesPropertyOperationOptions() CreateValidatesPropertyOperationOptions

func (CreateValidatesPropertyOperationOptions) ToHeaders 

func (o CreateValidatesPropertyOperationOptions) ToHeaders() *client.Headers

func (CreateValidatesPropertyOperationOptions) ToOData 

func (o CreateValidatesPropertyOperationOptions) ToOData() *odata.Query

func (CreateValidatesPropertyOperationOptions) ToQuery 

func (o CreateValidatesPropertyOperationOptions) ToQuery() *client.QueryParams

type CreateValidatesPropertyOperationResponse 

type CreateValidatesPropertyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CreateValidatesPropertyRequest 

type CreateValidatesPropertyRequest struct {
	DisplayName      nullable.Type[string] `json:"displayName,omitempty"`
	EntityType       nullable.Type[string] `json:"entityType,omitempty"`
	MailNickname     nullable.Type[string] `json:"mailNickname,omitempty"`
	OnBehalfOfUserId nullable.Type[string] `json:"onBehalfOfUserId,omitempty"`
}

type DeleteServicePrincipalOperationOptions 

type DeleteServicePrincipalOperationOptions struct {
	IfMatch   *string
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultDeleteServicePrincipalOperationOptions 

func DefaultDeleteServicePrincipalOperationOptions() DeleteServicePrincipalOperationOptions

func (DeleteServicePrincipalOperationOptions) ToHeaders 

func (o DeleteServicePrincipalOperationOptions) ToHeaders() *client.Headers

func (DeleteServicePrincipalOperationOptions) ToOData 

func (o DeleteServicePrincipalOperationOptions) ToOData() *odata.Query

func (DeleteServicePrincipalOperationOptions) ToQuery 

func (o DeleteServicePrincipalOperationOptions) ToQuery() *client.QueryParams

type DeleteServicePrincipalOperationResponse 

type DeleteServicePrincipalOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DirectoryObjectOperationPredicate 

type DirectoryObjectOperationPredicate struct {
}

func (DirectoryObjectOperationPredicate) Matches 

func (p DirectoryObjectOperationPredicate) Matches(input stable.DirectoryObject) bool

type ExtensionPropertyOperationPredicate 

type ExtensionPropertyOperationPredicate struct {
}

func (ExtensionPropertyOperationPredicate) Matches 

func (p ExtensionPropertyOperationPredicate) Matches(input stable.ExtensionProperty) bool

type GetMemberGroupsCompleteResult 

type GetMemberGroupsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type GetMemberGroupsCustomPager 

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

type GetMemberGroupsOperationOptions 

type GetMemberGroupsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultGetMemberGroupsOperationOptions 

func DefaultGetMemberGroupsOperationOptions() GetMemberGroupsOperationOptions

func (GetMemberGroupsOperationOptions) ToHeaders 

func (o GetMemberGroupsOperationOptions) ToHeaders() *client.Headers

func (GetMemberGroupsOperationOptions) ToOData 

func (o GetMemberGroupsOperationOptions) ToOData() *odata.Query

func (GetMemberGroupsOperationOptions) ToQuery 

func (o GetMemberGroupsOperationOptions) ToQuery() *client.QueryParams

type GetMemberGroupsOperationResponse 

type GetMemberGroupsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type GetMemberGroupsRequest 

type GetMemberGroupsRequest struct {
	SecurityEnabledOnly nullable.Type[bool] `json:"securityEnabledOnly,omitempty"`
}

type GetMemberObjectsCompleteResult 

type GetMemberObjectsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []string
}

type GetMemberObjectsCustomPager 

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

type GetMemberObjectsOperationOptions 

type GetMemberObjectsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultGetMemberObjectsOperationOptions 

func DefaultGetMemberObjectsOperationOptions() GetMemberObjectsOperationOptions

func (GetMemberObjectsOperationOptions) ToHeaders 

func (o GetMemberObjectsOperationOptions) ToHeaders() *client.Headers

func (GetMemberObjectsOperationOptions) ToOData 

func (o GetMemberObjectsOperationOptions) ToOData() *odata.Query

func (GetMemberObjectsOperationOptions) ToQuery 

func (o GetMemberObjectsOperationOptions) ToQuery() *client.QueryParams

type GetMemberObjectsOperationResponse 

type GetMemberObjectsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type GetMemberObjectsRequest 

type GetMemberObjectsRequest struct {
	SecurityEnabledOnly nullable.Type[bool] `json:"securityEnabledOnly,omitempty"`
}

type GetServicePrincipalOperationOptions 

type GetServicePrincipalOperationOptions struct {
	Expand    *odata.Expand
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Select    *[]string
}

func DefaultGetServicePrincipalOperationOptions 

func DefaultGetServicePrincipalOperationOptions() GetServicePrincipalOperationOptions

func (GetServicePrincipalOperationOptions) ToHeaders 

func (o GetServicePrincipalOperationOptions) ToHeaders() *client.Headers

func (GetServicePrincipalOperationOptions) ToOData 

func (o GetServicePrincipalOperationOptions) ToOData() *odata.Query

func (GetServicePrincipalOperationOptions) ToQuery 

func (o GetServicePrincipalOperationOptions) ToQuery() *client.QueryParams

type GetServicePrincipalOperationResponse 

type GetServicePrincipalOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *stable.ServicePrincipal
}

type GetsCountOperationOptions 

type GetsCountOperationOptions struct {
	ConsistencyLevel *odata.ConsistencyLevel
	Filter           *string
	Metadata         *odata.Metadata
	RetryFunc        client.RequestRetryFunc
	Search           *string
}

func DefaultGetsCountOperationOptions 

func DefaultGetsCountOperationOptions() GetsCountOperationOptions

func (GetsCountOperationOptions) ToHeaders 

func (o GetsCountOperationOptions) ToHeaders() *client.Headers

func (GetsCountOperationOptions) ToOData 

func (o GetsCountOperationOptions) ToOData() *odata.Query

func (GetsCountOperationOptions) ToQuery 

func (o GetsCountOperationOptions) ToQuery() *client.QueryParams

type GetsCountOperationResponse 

type GetsCountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]byte
}

type ListGetsAvailableExtensionPropertiesCompleteResult 

type ListGetsAvailableExtensionPropertiesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ExtensionProperty
}

type ListGetsAvailableExtensionPropertiesCustomPager 

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

type ListGetsAvailableExtensionPropertiesOperationOptions 

type ListGetsAvailableExtensionPropertiesOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultListGetsAvailableExtensionPropertiesOperationOptions 

func DefaultListGetsAvailableExtensionPropertiesOperationOptions() ListGetsAvailableExtensionPropertiesOperationOptions

func (ListGetsAvailableExtensionPropertiesOperationOptions) ToHeaders 

func (o ListGetsAvailableExtensionPropertiesOperationOptions) ToHeaders() *client.Headers

func (ListGetsAvailableExtensionPropertiesOperationOptions) ToOData 

func (o ListGetsAvailableExtensionPropertiesOperationOptions) ToOData() *odata.Query

func (ListGetsAvailableExtensionPropertiesOperationOptions) ToQuery 

func (o ListGetsAvailableExtensionPropertiesOperationOptions) ToQuery() *client.QueryParams

type ListGetsAvailableExtensionPropertiesOperationResponse 

type ListGetsAvailableExtensionPropertiesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ExtensionProperty
}

type ListGetsAvailableExtensionPropertiesRequest 

type ListGetsAvailableExtensionPropertiesRequest struct {
	IsSyncedFromOnPremises nullable.Type[bool] `json:"isSyncedFromOnPremises,omitempty"`
}

type ListGetsByIdsCompleteResult 

type ListGetsByIdsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.DirectoryObject
}

type ListGetsByIdsCustomPager 

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

type ListGetsByIdsOperationOptions 

type ListGetsByIdsOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
	Skip      *int64
	Top       *int64
}

func DefaultListGetsByIdsOperationOptions 

func DefaultListGetsByIdsOperationOptions() ListGetsByIdsOperationOptions

func (ListGetsByIdsOperationOptions) ToHeaders 

func (o ListGetsByIdsOperationOptions) ToHeaders() *client.Headers

func (ListGetsByIdsOperationOptions) ToOData 

func (o ListGetsByIdsOperationOptions) ToOData() *odata.Query

func (ListGetsByIdsOperationOptions) ToQuery 

func (o ListGetsByIdsOperationOptions) ToQuery() *client.QueryParams

type ListGetsByIdsOperationResponse 

type ListGetsByIdsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.DirectoryObject
}

type ListGetsByIdsRequest 

type ListGetsByIdsRequest struct {
	Ids   *[]string `json:"ids,omitempty"`
	Types *[]string `json:"types,omitempty"`
}

type ListServicePrincipalsCompleteResult 

type ListServicePrincipalsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []stable.ServicePrincipal
}

type ListServicePrincipalsCustomPager 

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

type ListServicePrincipalsOperationOptions 

type ListServicePrincipalsOperationOptions struct {
	ConsistencyLevel *odata.ConsistencyLevel
	Count            *bool
	Expand           *odata.Expand
	Filter           *string
	Metadata         *odata.Metadata
	OrderBy          *odata.OrderBy
	RetryFunc        client.RequestRetryFunc
	Search           *string
	Select           *[]string
	Skip             *int64
	Top              *int64
}

func DefaultListServicePrincipalsOperationOptions 

func DefaultListServicePrincipalsOperationOptions() ListServicePrincipalsOperationOptions

func (ListServicePrincipalsOperationOptions) ToHeaders 

func (o ListServicePrincipalsOperationOptions) ToHeaders() *client.Headers

func (ListServicePrincipalsOperationOptions) ToOData 

func (o ListServicePrincipalsOperationOptions) ToOData() *odata.Query

func (ListServicePrincipalsOperationOptions) ToQuery 

func (o ListServicePrincipalsOperationOptions) ToQuery() *client.QueryParams

type ListServicePrincipalsOperationResponse 

type ListServicePrincipalsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]stable.ServicePrincipal
}

type RemoveKeyOperationOptions 

type RemoveKeyOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultRemoveKeyOperationOptions 

func DefaultRemoveKeyOperationOptions() RemoveKeyOperationOptions

func (RemoveKeyOperationOptions) ToHeaders 

func (o RemoveKeyOperationOptions) ToHeaders() *client.Headers

func (RemoveKeyOperationOptions) ToOData 

func (o RemoveKeyOperationOptions) ToOData() *odata.Query

func (RemoveKeyOperationOptions) ToQuery 

func (o RemoveKeyOperationOptions) ToQuery() *client.QueryParams

type RemoveKeyOperationResponse 

type RemoveKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type RemoveKeyRequest 

type RemoveKeyRequest struct {
	KeyId *string `json:"keyId,omitempty"`
	Proof *string `json:"proof,omitempty"`
}

type RemovePasswordOperationOptions 

type RemovePasswordOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultRemovePasswordOperationOptions 

func DefaultRemovePasswordOperationOptions() RemovePasswordOperationOptions

func (RemovePasswordOperationOptions) ToHeaders 

func (o RemovePasswordOperationOptions) ToHeaders() *client.Headers

func (RemovePasswordOperationOptions) ToOData 

func (o RemovePasswordOperationOptions) ToOData() *odata.Query

func (RemovePasswordOperationOptions) ToQuery 

func (o RemovePasswordOperationOptions) ToQuery() *client.QueryParams

type RemovePasswordOperationResponse 

type RemovePasswordOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type RemovePasswordRequest 

type RemovePasswordRequest struct {
	KeyId *string `json:"keyId,omitempty"`
}

type RestoreOperationOptions 

type RestoreOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultRestoreOperationOptions 

func DefaultRestoreOperationOptions() RestoreOperationOptions

func (RestoreOperationOptions) ToHeaders 

func (o RestoreOperationOptions) ToHeaders() *client.Headers

func (RestoreOperationOptions) ToOData 

func (o RestoreOperationOptions) ToOData() *odata.Query

func (RestoreOperationOptions) ToQuery 

func (o RestoreOperationOptions) ToQuery() *client.QueryParams

type RestoreOperationResponse 

type RestoreOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        stable.DirectoryObject
}

type ServicePrincipalClient 

type ServicePrincipalClient struct {
	Client *msgraph.Client
}

func NewServicePrincipalClientWithBaseURI 

func NewServicePrincipalClientWithBaseURI(sdkApi sdkEnv.Api) (*ServicePrincipalClient, error)

func (ServicePrincipalClient) AddKey 

func (c ServicePrincipalClient) AddKey(ctx context.Context, id stable.ServicePrincipalId, input AddKeyRequest, options AddKeyOperationOptions) (result AddKeyOperationResponse, err error)

AddKey - Invoke action addKey. Adds a key credential to a servicePrincipal. This method along with removeKey can be used by a servicePrincipal to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. ServicePrincipals that don’t have any existing valid certificates (i.e.: no certificates have been added yet, or all certificates have expired), won’t be able to use this service action. Update servicePrincipal can be used to perform an update instead.

func (ServicePrincipalClient) AddPassword 

func (c ServicePrincipalClient) AddPassword(ctx context.Context, id stable.ServicePrincipalId, input AddPasswordRequest, options AddPasswordOperationOptions) (result AddPasswordOperationResponse, err error)

AddPassword - Invoke action addPassword. Add a strong password or secret to a servicePrincipal object.

func (ServicePrincipalClient) AddTokenSigningCertificate 

func (c ServicePrincipalClient) AddTokenSigningCertificate(ctx context.Context, id stable.ServicePrincipalId, input AddTokenSigningCertificateRequest, options AddTokenSigningCertificateOperationOptions) (result AddTokenSigningCertificateOperationResponse, err error)

AddTokenSigningCertificate - Invoke action addTokenSigningCertificate. Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part of the generated certificate. The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: + The keyCredentials object with the following objects: + A private key object with usage set to Sign. + A public key object with usage set to Verify. + The passwordCredentials object. All the objects have the same value of customKeyIdentifier. The passwordCredential is used to open the PFX file (private key). It and the associated private key object have the same value of keyId. When set during creation through the displayName property, the subject of the certificate cannot be updated. The startDateTime is set to the same time the certificate is created using the action. The endDateTime can be up to three years after the certificate is created.

func (ServicePrincipalClient) CheckMemberGroups 

func (c ServicePrincipalClient) CheckMemberGroups(ctx context.Context, id stable.ServicePrincipalId, input CheckMemberGroupsRequest, options CheckMemberGroupsOperationOptions) (result CheckMemberGroupsOperationResponse, err error)

CheckMemberGroups - Invoke action checkMemberGroups. Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.

func (ServicePrincipalClient) CheckMemberGroupsComplete 

func (c ServicePrincipalClient) CheckMemberGroupsComplete(ctx context.Context, id stable.ServicePrincipalId, input CheckMemberGroupsRequest, options CheckMemberGroupsOperationOptions) (result CheckMemberGroupsCompleteResult, err error)

CheckMemberGroupsComplete retrieves all the results into a single object

func (ServicePrincipalClient) CheckMemberObjects 

func (c ServicePrincipalClient) CheckMemberObjects(ctx context.Context, id stable.ServicePrincipalId, input CheckMemberObjectsRequest, options CheckMemberObjectsOperationOptions) (result CheckMemberObjectsOperationResponse, err error)

CheckMemberObjects - Invoke action checkMemberObjects

func (ServicePrincipalClient) CheckMemberObjectsComplete 

func (c ServicePrincipalClient) CheckMemberObjectsComplete(ctx context.Context, id stable.ServicePrincipalId, input CheckMemberObjectsRequest, options CheckMemberObjectsOperationOptions) (result CheckMemberObjectsCompleteResult, err error)

CheckMemberObjectsComplete retrieves all the results into a single object

func (ServicePrincipalClient) CreateServicePrincipal 

func (c ServicePrincipalClient) CreateServicePrincipal(ctx context.Context, input stable.ServicePrincipal, options CreateServicePrincipalOperationOptions) (result CreateServicePrincipalOperationResponse, err error)

CreateServicePrincipal - Create servicePrincipal. Create a new servicePrincipal object.

func (ServicePrincipalClient) CreateValidatesProperty 

func (c ServicePrincipalClient) CreateValidatesProperty(ctx context.Context, input CreateValidatesPropertyRequest, options CreateValidatesPropertyOperationOptions) (result CreateValidatesPropertyOperationResponse, err error)

CreateValidatesProperty - Invoke action validateProperties. Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties: 1. Validate the prefix and suffix naming policy 2. Validate the custom banned words policy 3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy.

func (ServicePrincipalClient) DeleteServicePrincipal 

func (c ServicePrincipalClient) DeleteServicePrincipal(ctx context.Context, id stable.ServicePrincipalId, options DeleteServicePrincipalOperationOptions) (result DeleteServicePrincipalOperationResponse, err error)

DeleteServicePrincipal - Delete servicePrincipal. Delete a servicePrincipal object.

func (ServicePrincipalClient) GetMemberGroups 

func (c ServicePrincipalClient) GetMemberGroups(ctx context.Context, id stable.ServicePrincipalId, input GetMemberGroupsRequest, options GetMemberGroupsOperationOptions) (result GetMemberGroupsOperationResponse, err error)

GetMemberGroups - Invoke action getMemberGroups. Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead.

func (ServicePrincipalClient) GetMemberGroupsComplete 

func (c ServicePrincipalClient) GetMemberGroupsComplete(ctx context.Context, id stable.ServicePrincipalId, input GetMemberGroupsRequest, options GetMemberGroupsOperationOptions) (result GetMemberGroupsCompleteResult, err error)

GetMemberGroupsComplete retrieves all the results into a single object

func (ServicePrincipalClient) GetMemberObjects 

func (c ServicePrincipalClient) GetMemberObjects(ctx context.Context, id stable.ServicePrincipalId, input GetMemberObjectsRequest, options GetMemberObjectsOperationOptions) (result GetMemberObjectsOperationResponse, err error)

GetMemberObjects - Invoke action getMemberObjects. Return all IDs for the groups, administrative units, and directory roles that a user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. Note: Only users and role-enabled groups can be members of directory roles.

func (ServicePrincipalClient) GetMemberObjectsComplete 

func (c ServicePrincipalClient) GetMemberObjectsComplete(ctx context.Context, id stable.ServicePrincipalId, input GetMemberObjectsRequest, options GetMemberObjectsOperationOptions) (result GetMemberObjectsCompleteResult, err error)

GetMemberObjectsComplete retrieves all the results into a single object

func (ServicePrincipalClient) GetServicePrincipal 

func (c ServicePrincipalClient) GetServicePrincipal(ctx context.Context, id stable.ServicePrincipalId, options GetServicePrincipalOperationOptions) (result GetServicePrincipalOperationResponse, err error)

GetServicePrincipal - Get servicePrincipal. Retrieve the properties and relationships of a servicePrincipal object.

func (ServicePrincipalClient) GetsCount 

func (c ServicePrincipalClient) GetsCount(ctx context.Context, options GetsCountOperationOptions) (result GetsCountOperationResponse, err error)

GetsCount - Get the number of the resource

func (ServicePrincipalClient) ListGetsAvailableExtensionProperties 

func (c ServicePrincipalClient) ListGetsAvailableExtensionProperties(ctx context.Context, input ListGetsAvailableExtensionPropertiesRequest, options ListGetsAvailableExtensionPropertiesOperationOptions) (result ListGetsAvailableExtensionPropertiesOperationResponse, err error)

ListGetsAvailableExtensionProperties - Invoke action getAvailableExtensionProperties. Return all directory extension definitions that have been registered in a directory, including through multi-tenant apps. The following entities support extension properties

func (ServicePrincipalClient) ListGetsAvailableExtensionPropertiesComplete 

func (c ServicePrincipalClient) ListGetsAvailableExtensionPropertiesComplete(ctx context.Context, input ListGetsAvailableExtensionPropertiesRequest, options ListGetsAvailableExtensionPropertiesOperationOptions) (ListGetsAvailableExtensionPropertiesCompleteResult, error)

ListGetsAvailableExtensionPropertiesComplete retrieves all the results into a single object

func (ServicePrincipalClient) ListGetsAvailableExtensionPropertiesCompleteMatchingPredicate 

func (c ServicePrincipalClient) ListGetsAvailableExtensionPropertiesCompleteMatchingPredicate(ctx context.Context, input ListGetsAvailableExtensionPropertiesRequest, options ListGetsAvailableExtensionPropertiesOperationOptions, predicate ExtensionPropertyOperationPredicate) (result ListGetsAvailableExtensionPropertiesCompleteResult, err error)

ListGetsAvailableExtensionPropertiesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServicePrincipalClient) ListGetsByIds 

func (c ServicePrincipalClient) ListGetsByIds(ctx context.Context, input ListGetsByIdsRequest, options ListGetsByIdsOperationOptions) (result ListGetsByIdsOperationResponse, err error)

ListGetsByIds - Invoke action getByIds. Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to

func (ServicePrincipalClient) ListGetsByIdsComplete 

func (c ServicePrincipalClient) ListGetsByIdsComplete(ctx context.Context, input ListGetsByIdsRequest, options ListGetsByIdsOperationOptions) (ListGetsByIdsCompleteResult, error)

ListGetsByIdsComplete retrieves all the results into a single object

func (ServicePrincipalClient) ListGetsByIdsCompleteMatchingPredicate 

func (c ServicePrincipalClient) ListGetsByIdsCompleteMatchingPredicate(ctx context.Context, input ListGetsByIdsRequest, options ListGetsByIdsOperationOptions, predicate DirectoryObjectOperationPredicate) (result ListGetsByIdsCompleteResult, err error)

ListGetsByIdsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServicePrincipalClient) ListServicePrincipals 

func (c ServicePrincipalClient) ListServicePrincipals(ctx context.Context, options ListServicePrincipalsOperationOptions) (result ListServicePrincipalsOperationResponse, err error)

ListServicePrincipals - List servicePrincipals. Retrieve a list of servicePrincipal objects.

func (ServicePrincipalClient) ListServicePrincipalsComplete 

func (c ServicePrincipalClient) ListServicePrincipalsComplete(ctx context.Context, options ListServicePrincipalsOperationOptions) (ListServicePrincipalsCompleteResult, error)

ListServicePrincipalsComplete retrieves all the results into a single object

func (ServicePrincipalClient) ListServicePrincipalsCompleteMatchingPredicate 

func (c ServicePrincipalClient) ListServicePrincipalsCompleteMatchingPredicate(ctx context.Context, options ListServicePrincipalsOperationOptions, predicate ServicePrincipalOperationPredicate) (result ListServicePrincipalsCompleteResult, err error)

ListServicePrincipalsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServicePrincipalClient) RemoveKey 

func (c ServicePrincipalClient) RemoveKey(ctx context.Context, id stable.ServicePrincipalId, input RemoveKeyRequest, options RemoveKeyOperationOptions) (result RemoveKeyOperationResponse, err error)

RemoveKey - Invoke action removeKey. Remove a key credential from a servicePrincipal. This method along with addKey can be used by a servicePrincipal to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.

func (ServicePrincipalClient) RemovePassword 

func (c ServicePrincipalClient) RemovePassword(ctx context.Context, id stable.ServicePrincipalId, input RemovePasswordRequest, options RemovePasswordOperationOptions) (result RemovePasswordOperationResponse, err error)

RemovePassword - Invoke action removePassword. Remove a password from a servicePrincipal object.

func (ServicePrincipalClient) Restore 

func (c ServicePrincipalClient) Restore(ctx context.Context, id stable.ServicePrincipalId, options RestoreOperationOptions) (result RestoreOperationResponse, err error)

Restore - Invoke action restore. Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups cannot be restored. Also, restoring an application doesn't restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted.

func (ServicePrincipalClient) UpdateServicePrincipal 

func (c ServicePrincipalClient) UpdateServicePrincipal(ctx context.Context, id stable.ServicePrincipalId, input stable.ServicePrincipal, options UpdateServicePrincipalOperationOptions) (result UpdateServicePrincipalOperationResponse, err error)

UpdateServicePrincipal - Upsert servicePrincipal. Create a new servicePrincipal object if it doesn't exist, or update the properties of an existing servicePrincipal object.

type ServicePrincipalOperationPredicate 

type ServicePrincipalOperationPredicate struct {
}

func (ServicePrincipalOperationPredicate) Matches 

func (p ServicePrincipalOperationPredicate) Matches(input stable.ServicePrincipal) bool

type UpdateServicePrincipalOperationOptions 

type UpdateServicePrincipalOperationOptions struct {
	Metadata  *odata.Metadata
	RetryFunc client.RequestRetryFunc
}

func DefaultUpdateServicePrincipalOperationOptions 

func DefaultUpdateServicePrincipalOperationOptions() UpdateServicePrincipalOperationOptions

func (UpdateServicePrincipalOperationOptions) ToHeaders 

func (o UpdateServicePrincipalOperationOptions) ToHeaders() *client.Headers

func (UpdateServicePrincipalOperationOptions) ToOData 

func (o UpdateServicePrincipalOperationOptions) ToOData() *odata.Query

func (UpdateServicePrincipalOperationOptions) ToQuery 

func (o UpdateServicePrincipalOperationOptions) ToQuery() *client.QueryParams

type UpdateServicePrincipalOperationResponse 

type UpdateServicePrincipalOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

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.