serviceprincipal

package
v0.20241111.1164443 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

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

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/beta/serviceprincipal"

Client Initialization

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

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.CreateGetsUserOwnedObject

ctx := context.TODO()

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


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

Example Usage: ServicePrincipalClient.CreatePasswordSingleSignOnCredentials

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

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


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

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.DeletePasswordSingleSignOnCredentials

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

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


read, err := client.DeletePasswordSingleSignOnCredentials(ctx, id, payload, serviceprincipal.DefaultDeletePasswordSingleSignOnCredentialsOperationOptions())
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.GetPasswordSingleSignOnCredentials

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

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


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

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.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.Restore

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

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


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

Example Usage: ServicePrincipalClient.UpdatePasswordSingleSignOnCredentials

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

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


read, err := client.UpdatePasswordSingleSignOnCredentials(ctx, id, payload, serviceprincipal.DefaultUpdatePasswordSingleSignOnCredentialsOperationOptions())
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 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        *beta.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 CreateGetsUserOwnedObjectOperationOptions 

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

func DefaultCreateGetsUserOwnedObjectOperationOptions 

func DefaultCreateGetsUserOwnedObjectOperationOptions() CreateGetsUserOwnedObjectOperationOptions

func (CreateGetsUserOwnedObjectOperationOptions) ToHeaders 

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

func (CreateGetsUserOwnedObjectOperationOptions) ToOData 

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

func (CreateGetsUserOwnedObjectOperationOptions) ToQuery 

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

type CreateGetsUserOwnedObjectOperationResponse 

type CreateGetsUserOwnedObjectOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        beta.DirectoryObject
}

type CreateGetsUserOwnedObjectRequest 

type CreateGetsUserOwnedObjectRequest struct {
	Type   nullable.Type[string] `json:"type,omitempty"`
	UserId nullable.Type[string] `json:"userId,omitempty"`
}

type CreatePasswordSingleSignOnCredentialsOperationOptions 

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

func DefaultCreatePasswordSingleSignOnCredentialsOperationOptions 

func DefaultCreatePasswordSingleSignOnCredentialsOperationOptions() CreatePasswordSingleSignOnCredentialsOperationOptions

func (CreatePasswordSingleSignOnCredentialsOperationOptions) ToHeaders 

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

func (CreatePasswordSingleSignOnCredentialsOperationOptions) ToOData 

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

func (CreatePasswordSingleSignOnCredentialsOperationOptions) ToQuery 

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

type CreatePasswordSingleSignOnCredentialsOperationResponse 

type CreatePasswordSingleSignOnCredentialsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.PasswordSingleSignOnCredentialSet
}

type CreatePasswordSingleSignOnCredentialsRequest 

type CreatePasswordSingleSignOnCredentialsRequest struct {
	Credentials *[]beta.Credential `json:"credentials,omitempty"`
	Id          *string            `json:"id,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        *beta.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 DeletePasswordSingleSignOnCredentialsOperationOptions 

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

func DefaultDeletePasswordSingleSignOnCredentialsOperationOptions 

func DefaultDeletePasswordSingleSignOnCredentialsOperationOptions() DeletePasswordSingleSignOnCredentialsOperationOptions

func (DeletePasswordSingleSignOnCredentialsOperationOptions) ToHeaders 

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

func (DeletePasswordSingleSignOnCredentialsOperationOptions) ToOData 

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

func (DeletePasswordSingleSignOnCredentialsOperationOptions) ToQuery 

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

type DeletePasswordSingleSignOnCredentialsOperationResponse 

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

type DeletePasswordSingleSignOnCredentialsRequest 

type DeletePasswordSingleSignOnCredentialsRequest struct {
	Id *string `json:"id,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 beta.DirectoryObject) 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 GetPasswordSingleSignOnCredentialsOperationOptions 

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

func DefaultGetPasswordSingleSignOnCredentialsOperationOptions 

func DefaultGetPasswordSingleSignOnCredentialsOperationOptions() GetPasswordSingleSignOnCredentialsOperationOptions

func (GetPasswordSingleSignOnCredentialsOperationOptions) ToHeaders 

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

func (GetPasswordSingleSignOnCredentialsOperationOptions) ToOData 

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

func (GetPasswordSingleSignOnCredentialsOperationOptions) ToQuery 

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

type GetPasswordSingleSignOnCredentialsOperationResponse 

type GetPasswordSingleSignOnCredentialsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *beta.PasswordSingleSignOnCredentialSet
}

type GetPasswordSingleSignOnCredentialsRequest 

type GetPasswordSingleSignOnCredentialsRequest struct {
	Id *string `json:"id,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        *beta.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 ListGetsByIdsCompleteResult 

type ListGetsByIdsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []beta.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        *[]beta.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              []beta.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        *[]beta.ServicePrincipal
}

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        beta.DirectoryObject
}

type RestoreRequest 

type RestoreRequest struct {
	AutoReconcileProxyConflict nullable.Type[bool] `json:"autoReconcileProxyConflict,omitempty"`
}

type ServicePrincipalClient 

type ServicePrincipalClient struct {
	Client *msgraph.Client
}

func NewServicePrincipalClientWithBaseURI 

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

func (ServicePrincipalClient) AddTokenSigningCertificate 

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

AddTokenSigningCertificate - Invoke action addTokenSigningCertificate. Creates a self-signed signing certificate and returns 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. Once 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 beta.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 beta.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 beta.ServicePrincipalId, input CheckMemberObjectsRequest, options CheckMemberObjectsOperationOptions) (result CheckMemberObjectsOperationResponse, err error)

CheckMemberObjects - Invoke action checkMemberObjects

func (ServicePrincipalClient) CheckMemberObjectsComplete 

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

CheckMemberObjectsComplete retrieves all the results into a single object

func (ServicePrincipalClient) CreateGetsUserOwnedObject 

func (c ServicePrincipalClient) CreateGetsUserOwnedObject(ctx context.Context, input CreateGetsUserOwnedObjectRequest, options CreateGetsUserOwnedObjectOperationOptions) (result CreateGetsUserOwnedObjectOperationResponse, err error)

CreateGetsUserOwnedObject - Invoke action getUserOwnedObjects. Retrieve a list of recently deleted application and group objects owned by the specified user. This API returns up to 1,000 deleted objects owned by the user, sorted by ID, and doesn't support pagination.

func (ServicePrincipalClient) CreatePasswordSingleSignOnCredentials 

func (c ServicePrincipalClient) CreatePasswordSingleSignOnCredentials(ctx context.Context, id beta.ServicePrincipalId, input CreatePasswordSingleSignOnCredentialsRequest, options CreatePasswordSingleSignOnCredentialsOperationOptions) (result CreatePasswordSingleSignOnCredentialsOperationResponse, err error)

CreatePasswordSingleSignOnCredentials - Invoke action createPasswordSingleSignOnCredentials. Create single sign-on credentials using a password for a user or group.

func (ServicePrincipalClient) CreateServicePrincipal 

func (c ServicePrincipalClient) CreateServicePrincipal(ctx context.Context, input beta.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. For validating properties of an existing group, use the validateProperties function for groups. The following 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 the mail nickname is unique This API returns with the first failure encountered. If one or more properties fail multiple validations, only the property with 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.

func (ServicePrincipalClient) DeletePasswordSingleSignOnCredentials 

func (c ServicePrincipalClient) DeletePasswordSingleSignOnCredentials(ctx context.Context, id beta.ServicePrincipalId, input DeletePasswordSingleSignOnCredentialsRequest, options DeletePasswordSingleSignOnCredentialsOperationOptions) (result DeletePasswordSingleSignOnCredentialsOperationResponse, err error)

DeletePasswordSingleSignOnCredentials - Invoke action deletePasswordSingleSignOnCredentials. Delete single sign-on credentials using a password for a user or group.

func (ServicePrincipalClient) DeleteServicePrincipal 

func (c ServicePrincipalClient) DeleteServicePrincipal(ctx context.Context, id beta.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 beta.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 beta.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 beta.ServicePrincipalId, input GetMemberObjectsRequest, options GetMemberObjectsOperationOptions) (result GetMemberObjectsOperationResponse, err error)

GetMemberObjects - Invoke action getMemberObjects

func (ServicePrincipalClient) GetMemberObjectsComplete 

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

GetMemberObjectsComplete retrieves all the results into a single object

func (ServicePrincipalClient) GetPasswordSingleSignOnCredentials 

func (c ServicePrincipalClient) GetPasswordSingleSignOnCredentials(ctx context.Context, id beta.ServicePrincipalId, input GetPasswordSingleSignOnCredentialsRequest, options GetPasswordSingleSignOnCredentialsOperationOptions) (result GetPasswordSingleSignOnCredentialsOperationResponse, err error)

GetPasswordSingleSignOnCredentials - Invoke action getPasswordSingleSignOnCredentials. Get a list of single sign-on credentials using a password for a user or group.

func (ServicePrincipalClient) GetServicePrincipal 

func (c ServicePrincipalClient) GetServicePrincipal(ctx context.Context, id beta.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) 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. 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) Restore 

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

Restore - Invoke action restore. Restore a recently deleted application, externalUserProfile, group, pendingExternalUserProfile, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. This isn't applicable to security groups, which are deleted permanently. 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) UpdatePasswordSingleSignOnCredentials 

func (c ServicePrincipalClient) UpdatePasswordSingleSignOnCredentials(ctx context.Context, id beta.ServicePrincipalId, input UpdatePasswordSingleSignOnCredentialsRequest, options UpdatePasswordSingleSignOnCredentialsOperationOptions) (result UpdatePasswordSingleSignOnCredentialsOperationResponse, err error)

UpdatePasswordSingleSignOnCredentials - Invoke action updatePasswordSingleSignOnCredentials. Update single sign-on credentials using a password for a user or group.

func (ServicePrincipalClient) UpdateServicePrincipal 

func (c ServicePrincipalClient) UpdateServicePrincipal(ctx context.Context, id beta.ServicePrincipalId, input beta.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 beta.ServicePrincipal) bool

type UpdatePasswordSingleSignOnCredentialsOperationOptions 

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

func DefaultUpdatePasswordSingleSignOnCredentialsOperationOptions 

func DefaultUpdatePasswordSingleSignOnCredentialsOperationOptions() UpdatePasswordSingleSignOnCredentialsOperationOptions

func (UpdatePasswordSingleSignOnCredentialsOperationOptions) ToHeaders 

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

func (UpdatePasswordSingleSignOnCredentialsOperationOptions) ToOData 

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

func (UpdatePasswordSingleSignOnCredentialsOperationOptions) ToQuery 

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

type UpdatePasswordSingleSignOnCredentialsOperationResponse 

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

type UpdatePasswordSingleSignOnCredentialsRequest 

type UpdatePasswordSingleSignOnCredentialsRequest struct {
	Credentials *[]beta.Credential `json:"credentials,omitempty"`
	Id          *string            `json:"id,omitempty"`
}

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.