ServicePrincipalCertificate
Manages a Certificate associated with a Service Principal within Azure Active Directory.
NOTE: If you’re authenticating using a Service Principal then it must have permissions to both
Read and write all applicationsandSign in and read user profilewithin theWindows Azure Active DirectoryAPI.
Create a ServicePrincipalCertificate Resource
new ServicePrincipalCertificate(name: string, args: ServicePrincipalCertificateArgs, opts?: CustomResourceOptions);def ServicePrincipalCertificate(resource_name, opts=None, end_date=None, end_date_relative=None, key_id=None, service_principal_id=None, start_date=None, type=None, value=None, __props__=None);func NewServicePrincipalCertificate(ctx *Context, name string, args ServicePrincipalCertificateArgs, opts ...ResourceOption) (*ServicePrincipalCertificate, error)public ServicePrincipalCertificate(string name, ServicePrincipalCertificateArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args ServicePrincipalCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServicePrincipalCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServicePrincipalCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
ServicePrincipalCertificate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The ServicePrincipalCertificate resource accepts the following input properties:
- Service
Principal stringId The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- Value string
The Certificate for this Service Principal.
- End
Date string The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- End
Date stringRelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- Key
Id string A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- Start
Date string The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- Type string
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.
- Service
Principal stringId The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- Value string
The Certificate for this Service Principal.
- End
Date string The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- End
Date stringRelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- Key
Id string A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- Start
Date string The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- Type string
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.
- service
Principal stringId The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- value string
The Certificate for this Service Principal.
- end
Date string The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- end
Date stringRelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- key
Id string A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- start
Date string The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- type string
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.
- service_
principal_ strid The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- value str
The Certificate for this Service Principal.
- end_
date str The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- end_
date_ strrelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- key_
id str A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- start_
date str The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- type str
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServicePrincipalCertificate resource produces the following output properties:
Look up an Existing ServicePrincipalCertificate Resource
Get an existing ServicePrincipalCertificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServicePrincipalCertificateState, opts?: CustomResourceOptions): ServicePrincipalCertificatestatic get(resource_name, id, opts=None, end_date=None, end_date_relative=None, key_id=None, service_principal_id=None, start_date=None, type=None, value=None, __props__=None);func GetServicePrincipalCertificate(ctx *Context, name string, id IDInput, state *ServicePrincipalCertificateState, opts ...ResourceOption) (*ServicePrincipalCertificate, error)public static ServicePrincipalCertificate Get(string name, Input<string> id, ServicePrincipalCertificateState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- End
Date string The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- End
Date stringRelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- Key
Id string A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- Service
Principal stringId The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- Start
Date string The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- Type string
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.- Value string
The Certificate for this Service Principal.
- End
Date string The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- End
Date stringRelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- Key
Id string A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- Service
Principal stringId The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- Start
Date string The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- Type string
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.- Value string
The Certificate for this Service Principal.
- end
Date string The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- end
Date stringRelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- key
Id string A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- service
Principal stringId The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- start
Date string The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- type string
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.- value string
The Certificate for this Service Principal.
- end_
date str The End Date which the Certificate is valid until, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.- end_
date_ strrelative A relative duration for which the Certificate is valid until, for example
240h(10 days) or2400h30m. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Changing this field forces a new resource to be created.- key_
id str A GUID used to uniquely identify this Certificate. If not specified a GUID will be created. Changing this field forces a new resource to be created.
- service_
principal_ strid The ID of the Service Principal for which this certificate should be created. Changing this field forces a new resource to be created.
- start_
date str The Start Date which the Certificate is valid from, formatted as a RFC3339 date string (e.g.
2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.- type str
The type of key/certificate. Must be one of
AsymmetricX509CertorSymmetric. Changing this fields forces a new resource to be created.- value str
The Certificate for this Service Principal.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azuread
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azureadTerraform Provider.